Create subscription order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Before you create a subscription order

Products in orders

  • In subscription orders, you can only add one product.
  • If the pricing configuration of a product is not locked, you can change the pricing when you create an order. For fees, discounts, and taxes, you can specify an amount in each order, with no percentage discount.

Manage scheduled payments

  • To use the API to manage scheduled payments, see Scheduled Payments. You can skip, cancel, or reschedule billing events.

Subscription periods

  • When you create a subscription product in the UI, you can select from three intervals: MONTH, QUARTER, or YEAR.
  • If you do not lock the payment configuration in the product, you can select new payment configuration when creating an order with the UI or API. With the API, change the recurring_collection_interval. This lets you select from the standard subscription periods of MONTH, QUARTER or YEAR.
  • After you create a subscription, you can use the scheduled payments endpoint to change the subscription period. This allows you to create custom payment intervals using scheduled_duration and scheduled_interval that will override the standard subscription intervals.
  • You can change the scheduled_interval to an integer value, and set the scheduled_duration_unit to DAY, WEEK, MONTH, or YEAR.
  • When you update scheduled payments it does not change the order, but it does change when BillPro collects the payments.
  • See also the tutorial to Create a subscription with a trial

Order status

  • BillPro creates a payment link and sets the pending status for the order, but the BillPro API does not automatically send the payment link to the customer.

Taking payments

  • You can send the payment link to the customer by email
  • You can integrate with BillPro's payment link to redirect the customer to BillPro's secure checkout. See Integrate with payment links.
  • With CardCorp merchant accounts, when you create the order, you can create a checkout in the payment gateway to use in an iframe integration. See Integrate with custom checkout and payment iframe. If the user doesn't complete their transaction within 25 minutes, the checkout expires, and you can renew it with the Renew Checkout request.

Notifications

Delete old pending orders

  • Create a regular process to remove old orders with a Pending status in the UI. See Track pending orders.

Subscription order response

AttributeDescription
scheduled_durationFor a standard subscription period of MONTH, QUARTER, or YEAR, this value will be null. If you have changed the subscription payment using the scheduled payments endpoint, the value will be DAY, WEEK, MONTH, YEAR.
scheduled_unitFor a standard subscription period, this will be MONTH, QUARTER, or YEAR.
scheduled_intervalFor a monthly order, this value will be 1.

Query Params
int32

If you have more than one profile, you must supply the ID of the profile to use

Body Params
order
object
required

Subscription object

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json