Newer Version Available

This content describes an older version of this product. View Latest

Process First Payment Billing for Subscriptions Action

Creates invoices for orders containing subscription products. When an order containing subscription products is placed in a B2B or D2C store, the first term payment for subscription products is captured, but an invoice isn’t generated. This action uses Revenue Cloud’s billing system to generate and settle a subscripition order’s first-term invoice and create a billing schedule for the subscription order.

Special Access Rules

This action is available in API version 63.0 and later for users with system administrator access or the BillingTransactionToBSApiUser, InvoiceOrErrorRecoveryAPI, and RLMBilliingAccess users permissions assigned, along with any of these licenses enabled:

  • B2B Commerce or D2C Commerce and Salesforce Payments
  • Revenue Lifecycle Management and Salesforce Pricing

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/processFirstPaymentBilling
Formats
JSON, XML
HTTP Methods
GET, HEAD, POST
Authentication
Authorization: Bearer token

Inputs

Input Details
correlationId
Type
String
Description
The request correlation ID used for tracking the request.
orderSummaryId
Type
String
Description
The ID of the order summary record.

Outputs

Output Details
correlationId
Type
STRING
Description
The request correlationID used for tracking the request.
requestId
Type
STRING
Description
The ID of the request.

Example

Sample Request

Here’s a sample request with correlationId and orderSummaryId:

1{
2  "inputs": [
3    {
4      "orderSummaryId": "1OsLT0000098gcu0AA",
5      "correlationId": "4869bd78-3af4-40ff-8475-899d711b5db4"
6    }
7  ]
8}

Sample Response

1[
2  {
3    "actionName": "processFirstPaymentBilling",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "requestId": "fcec4cff-3f26-45fd-8193-0a599dbb7d03",
10      "correlationId": "4869bd78-3af4-40ff-8475-899d711b5db4"
11    },
12    "sortOrder": -1,
13    "version": 1
14  }
15]