Standalone Billing Schedule Input

Input representation of the request to create a billing schedule based on transaction details. This representation includes the transaction and context service details.

The Create Standalone Billing Schedules (POST) API uses the StandaloneBillingContext context definition to hydrate the context of the transaction. The context definition includes these mappings.

  • The TransactionMapping maps the fields of the transaction to the attributes of the Transaction node.
  • The BSGEntitiesMapping maps the attributes of the Billing Schedule node, the Billing Schedule Group node, and Billing Schedule Group Relationship node to the fields of the corresponding Salesforce objects.

For the StandaloneBillingContext context definition to hydrate all the required data, transaction data for the mandatory context tags are required. Here are the topics that mention the mandatory and optional tags, sample transaction details, and sample payloads for various types of transactions.

JSON Example 

 
1{
2  "transactionDetails": "{\"nodeName\": [{\"id\":\"801Az00000aynKZIAY\", \"businessSobjectType\": \"Order\"}]}",
3  "transactionContextDetails": {
4    "contextDefinitionName": "StandaloneBillingContext",
5    "intraContextCustomMappingName": "CustomContextMapping",
6    "readContextMappingName": "OrderTransactionMapping",
7    "saveContextMappingName": "BSGEntitiesMapping"
8  }
9}

Properties 
NameTypeDescriptionRequired or OptionalAvailable Version
transaction​ContextDetailsStandalone Billing Schedule Metadata Input[]Details of the context definition and its mappings that are used to hydrate the transaction data and save it in the appropriate Billing fields.Required64.0
transaction​DetailsStringInput JSON data that includes the ID of the transaction record for which the billing schedule must be created and other additional transaction details. The API request supports a single mapping ID. You can send separate requests for line items and line details by using their respective mapping IDs. However, this approach can result in duplicate billing schedules for the same line items and line details.Required64.0

  • One-Time New Sale Transaction

    Understand the required values and key considerations before you create a billing schedule for a new sale transaction with the OneTime selling model type.

  • Term-Defined New Sale Transaction

    Understand the required values and key considerations before you create a billing schedule for a new sale transaction with the TermDefined selling model type.

  • Evergreen New Sale Transaction

    Understand the required values and key considerations before you create a billing schedule for a new sale transaction with the Evergreen selling model type.

  • New Sale Transaction With Bundled Products

    Understand the required values and key considerations before you create a billing schedule for a new sale transaction with bundled products.

  • New Sale Transaction With Ramped Products

    Understand the required values and key considerations before you create a billing schedule for a new sale transaction with ramped products.

  • New Sale Transaction With Usage Products

    Understand the required values and key considerations before you create a billing schedule for a new sale transaction with usage-based products.

  • Amended Transaction

    Learn how amendments update quantity, price, and end date in billing schedules along with delta-only price transactions and billing-frequency changes at the billing schedule level.

  • Renewal Transaction

    Create a renewal billing schedule for termed subscriptions that continues without a gap, starting the day after the current billing schedule group ends and running for the same term length.

  • Early Renewal Transaction

    Early Renewal ends the current term at an effective date and starts a renewed term to a new end date, creating two billing schedules in one request. The request creates a negative segment for the remaining original term and a positive segment for the renewal term.

  • Canceled Transaction

    Cancel an entire billing schedule from a specified date. Specify only the cancellation date and billing schedule group identifier. The API computes the logic to split the cancellation across overlapping billing schedules and creates one cancel transaction per segment.

Get Started with Revenue Management Developer Resources
Revenue Management Settings
Revenue Management Deployment
Product Catalog Management
Salesforce Pricing
Rate Management
Product Configurator
Transaction Management
Advanced Approvals
Dynamic Revenue Orchestrator
Usage Management
Billing
Billing Standard Objects
Billing Fields on Standard Objects
Salesforce Payments Objects in Billing
Billing Platform Events
Billing Standard Invocable Actions
Billing Business APIs
Billing Business API Limits
Resources
Request Bodies
Address Input
Addresses Input
Batch Invoice Filter Criteria Input
Batch Invoice Scheduler Input
Billing Checkout Input
Billing Schedule Recovery Input
Context-Aware Billing Schedule
Standalone Billing Schedule Input
One-Time New Sale Transaction
Term-Defined New Sale Transaction
Evergreen New Sale Transaction
New Sale Transaction With Bundled Products
New Sale Transaction With Ramped Products
New Sale Transaction With Usage Products
Amended Transaction
Renewal Transaction
Early Renewal Transaction
Canceled Transaction
Standalone Billing Schedule Metadata Input
Composite Collection Plan Input
Collection Plan Input
Collection Plan Item Input
Convert Negative Invoice Lines Input
Credit Invoice Input
Credit Invoice Line Input
Credit Invoice Line Tax Input
Credit Memo Addresses Input
Credit Memo Apply Input
Credit Memo Apply Application Input
Credit Memo Draft to Posted Input
Credit Memo Unapply Input
Credit Memo Line Apply Input
Credit Memo Line Application Input
Credit Memo Line Unapply Input
Customer Details Input
Frequency Cadence Options
Graph Record for Invoice Ingestion
Invoice Draft To Posted Input
Invoice Estimated Tax Calculation Input
Invoice Ingestion Input
Invoice Input for Ingestion
Invoice Input
Invoice Preview Input
Line Item Input
On-Demand Document Generation Input
Payment Line Apply Input
Payment Line Unapply Input
Payment Run Batch Filter Criteria Input
Payment Batch Scheduler Input
Payment Scheduler Update Input
Posted Invoice List Write-Off Input
Posted Invoice Write-Off Input
Refund Credit Memo Input
Refund Line Apply Input
Resume Billing Input
Resume Billing Object Input
Rules Application Input
Selection Condition Input
Seller Details Input
Send Email Input
Sequence Policy Input
Sequence Gap Reconciliation Input
Sequences Assignment Input
Standalone Credit Memo Charge Input
Standalone Credit Memo Input
Standalone Credit Memo Tax Input
Account Statement Input
Suspend Billing Input
Suspend Billing Object Input
Tax Calculation Input
Void Posted Credit Memo Input
Void Posted Invoice Input
Response Bodies
Billing Apex Reference
Billing Metadata API Types
Revenue Management Associated Objects
Previous Versions