HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Creates a subscription billing plan for the given Subscription ID.

Upon success, the operation returns a status code of 201 (Created).

If an invalid field or value is submitted, a status code of 400 (Bad Request) will be returned.

If the Subscription ID cannot be associated with an active subscription, a status code of 404 (Not Found) will be returned.

Value and ValueType work in conjunction to provide Revolv3 with information on how to act.

A subscription billing plan with a Value of 10.00 and a ValueType of 'standard' indicate the subscription should be billed for $10.00.

A subscription billing plan with a Value of 10.00 and a ValueType of 'discountPercentage' indicate the subscription should receive a 10% discount.

Required Fields
NameDescription
BillingPlanNameThe subscription's primary payment information
BillingPlanValueValue for which the billing plan should be executed for
Optional Fields
NameDescriptionDefault value
BillingPlanCycleCountThe number of times the billing plan should be billed before expiration-1
BillingPlanValueTypeA qualifier for how the value should be interpreted (e.g. standard, discount, discountPercentage, finalDiscount, or priceOverride)Standard
BillingPlanStartCycleDelayAmount of subscription cycle to delay the start date of the billing plan0
Language
Click Try It! to start a request and see the response here!