Plans
Last updated
Last updated
The Plans resource defines the recurring billing behavior in subscriptions.
Gets the Plans specified in the request.
/plans
The state associated with the Plans you want to retrieve.
The billing interval associated with the Plans you want to retrieve.
A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xzy, your subsequent calls can include endingBefore=xzy in order to fetch the previous page of the list.
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xzy, your subsequent calls can include startingAfter=xzy in order to fetch the next page of the list.
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
Submit this request to create a Plan.
/plans
The unique identifier of a Plan.
4a1a1fdd-2f7b-4a4e-92d2-2e843f06e82aThe contractual agreement displayed to the customer during the acquisition process.
These are the terms...Indicates the agreed upon length of the contract. For example, an annual subscription should have a value of 365.
365How often the customer is billed per the unit of time specified by <code>interval</code> (e.g. every 3 months).
1Describes the subscription products or services added to this plan.
Womens cotton dressesThe number of days before the opening of the invoice that the reminder event is triggered.
7The number of days before the due date that billing is initiated.
4Represents the number of days that Digital River attempts to collect payment.
10Key-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}The supported billing intervals
monthyear, month, week, dayThe valid states of a plan. Setting a plan to <code>deactivated</code> causes all connected subscriptions to end with the current period.
activedraft, active, discontinued, deactivatedRetrieves the details of a Plan.
/plans/{id}
Plan identifier.
Updates the specified Plan.
/plans/{id}
The Plan identifier.
Describes the subscription products or services added to this plan.
Wireless keyboardsThe number of days before the opening of the invoice that the reminder event is triggered.
7The number of days before the due date that billing is initiated.
4Represents the number of days that Digital River attempts to collect payment.
10Key-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}The valid states of a plan. Setting a plan to <code>deactivated</code> causes all connected subscriptions to end with the current period.
activedraft, active, discontinued, deactivatedPermanently deletes a Plan. In the request, send the plan's unique identifier as a path parameter. Only plans in a <code>draft</code> can be deleted.
/plans/{id}
Plan identifier
No body