Create a pricing plan subscription and schedule. This will also result in a first invoice being created for the provided pricing plan schedule and subscription.
Requires the PRICING_PLAN_SUBSCRIPTION.CREATE permission.
Authentication
X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
version
version
Headers
x-platform-id
Platform ID.
Request
This endpoint expects an object.
pricing_plan_schedules
Details of the schedule for subscription.
customer
Details of the customer.
pricing_plan_subscription
Details of the subscription.
first_payment
The first payment made, if any, for the pricing plan subscription's initial invoice.
payment_method
Details of the payment method.
pricing_plan_subscription_start_at
In case of a template pricing plan subscription, indicate if the start_at should be updated.
enabled_pricings
entitlements_summary
Details of the all entitlements for this customer based on all their active subscriptions.
invoice
The first invoice created as a result of this subscription.
Response
OK
pricing_plan_schedules
Details of the schedule for subscription.
customer
Details of the customer.
pricing_plan_subscription
Details of the subscription.
first_payment
The first payment made, if any, for the pricing plan subscription's initial invoice.
payment_method
Details of the payment method.
pricing_plan_subscription_start_at
In case of a template pricing plan subscription, indicate if the start_at should be updated.
enabled_pricings
entitlements_summary
Details of the all entitlements for this customer based on all their active subscriptions.
invoice
The first invoice created as a result of this subscription.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error