Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 1.24 KB

File metadata and controls

23 lines (19 loc) · 1.24 KB

BillaBear.SubscriptionStartBody

Properties

Name Type Description Notes
subscriptionPlan String The ID for the subscription plan to be used (Can also be the code name)
paymentDetails String The Id for the customer's payment details to be used [optional]
cardToken String A stripe card token that's been created using Stripe's js sdk. It'll create the payment details for the customer. [optional]
price String The ID for the price to be used [optional]
schedule String The schedule of the plan that is to be started. Only used if price isn't given. Requires currency as well. [optional]
currency String The currency of the plan that is to be started. Only used if price isn't given. Requires schedule as well. [optional]
seatNumbrers Number [optional]
denyTrial Bool [optional]
metadata Object Any metadata you want to add to a subscription [optional]

Enum: ScheduleEnum

  • week (value: "week")
  • month (value: "month")
  • year (value: "year")
  • oneOff (value: "one-off")