| Name | Type | Description | Notes |
|---|---|---|---|
| subscriptionPlan | UUID | The ID for the subscription plan to be used (Can also be the code name) | |
| paymentDetails | UUID | 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 | UUID | The ID for the price to be used | [optional] |
| schedule | ScheduleEnum | 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 | Integer | [optional] | |
| denyTrial | Bool | [optional] | |
| metadata | Object | Any metadata you want to add to a subscription | [optional] |
| Name | Value |
|---|---|
| WEEK | "week" |
| MONTH | "month" |
| YEAR | "year" |
| ONE_OFF | "one-off" |