Subscriptions

Create subscription

post/subscriptions

Request

Headers

x-vfi-api-idempotencyKeystring

A value you specify that uniquely identifies the transaction. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the transaction.

Request body */*

paymentProviderContractstring required

PayPal Payment Provider Contract UUID

planIdstring required

The ID of the plan

startTimestring date

The date and time when the subscription started

quantityinteger

The quantity of the product in the subscription

customIdstring

The custom id for the subscription. Can be invoice id

Response

Created

idstring required

The PayPal-generated ID for the subscription.

statusstring required

The status of the subscription.

planIdstring required

The ID of the plan

statusUpdateTimestring date required

Status update time.

planOverriddenboolean required

Indicates whether the subscription has overridden any plan attributes.

quantitystring

The quantity of the product in the subscription.

startTimestring date

The quantity of the product in the subscription.

createdAtstring date

The quantity of the product in the subscription.

approvalUrlstring required

PayPal approval URL

Changes

No recorded changes to this operation across all 1 revision of this API.