On This Page

Requirements for the Subscription Creation Script

Adhere to these requirements as you write the subscription creation script.
Migration log file
The script logs each API request message sent and the corresponding response information returned by the
Cybersource
 subscription service.
Retry logic
For failed subscription creation requests, correct the request and resubmit it to the subscription service.
Billing start date
Cybersource
 Recurring Billing subscriptions begin billing on the date specified in the
subscriptionInformation.startDate
 field.
Reusable set of billing periods and billing cycles
Create a
subscription plan
 that defines a billing period (or billing cycle) and a number of billing cycles. In the REST API, use these fields:
Plan options for new subscriptions
Cybersource
 Recurring Billing subscriptions support these plan options:
  • Define a
    one-time plan
     for a subscription instead of creating a subscription plan.
  • Use the plan information defined in the
    existing plan
     referenced by the
    subscriptionInformation. planId
     field in the subscription creation message.
  • Specify
    overrides
     to some of the information in the referenced plan. For example, if the subscription was for a fixed period, specify the remaining number of billing cycles in the
    planInformation. billingCycles.total
     field.
For detailed examples of how to create plan-specific subscriptions, see Reference Information.
RELATED TO THIS PAGE