Create Billing Schedules From Billing Transaction Action

Create one or more billing schedules for a specified billing transaction ID.

This action calls the Context-Aware Billing Schedule API to retrieve the billing transaction items associated with the billing transaction ID. The API generates the corresponding billing schedules for each of the billing transaction items for operations such as transaction modifications, renewals, cancellations, and new sales.

This action is available in API version 62.0 and later.

Special Access Rules

The Create Billing Schedules From Billing Transaction action is available in Enterprise, Unlimited, and Developer Editions where Billing is enabled. To use this action, you need the Create Billing Schedules From Billing Transactions API permission set.

Supported REST HTTP Methods

URI
/services/data/v63.0/actions/standard/createBillingSchedulesFromBillingTransaction
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
billingTransactionId
Type
string
Description

Required.

ID of the billing transaction record to create one or more billing schedules for.

Outputs

Output Details
requestId
Type
string
Description
Universally Unique Identifier (UUID) that’s used to track the status of the asynchronous action.
statusUrl
Type
string
Description
URL that’s used to check the status of the API request.

Example

POST

This example shows a sample request for the Create Billing Schedules From Billing Transaction action.

{
  "inputs": [
    {
      "billingTransactionId": "801xx000003JztvAAC"
    }
  ]
}

This example shows a sample response for the Create Billing Schedules From Billing Transaction action.

{
  "actionName": "createBillingSchedulesFromBillingTransaction",
  "errors": null,
  "isSuccess": true,
  "outputValues": {
    "requestId": "4sFDU00000000652AA",
    "statusUrl": "/services/data/v62.0/sobjects/AsyncOperationTracker/16Pxx0000004NhAEAU"
  },
  "sortOrder": -1,
  "version": 1
}