PApaypal
plans

Create plan

Creates a plan that defines pricing and billing cycle details for subscriptions.

post/v1/billing/plans

Request

Headers

Content-Typestring required

The media type. Required for operations with a request body. The value is application/<format>, where the format is json.

Preferstring

The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul>

PayPal-Request-Idstring

The server stores keys for 72 hours.

Request body

product_idstring required

The ID of the product created through Catalog Products API.

namestring required

The plan name.

descriptionstring

The detailed description of the plan.

quantity_supportedboolean

Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that shows billing plan details.

idstring

The unique PayPal-generated ID for the plan.

product_idstring

The ID for the product.

namestring

The plan name.

descriptionstring

The detailed description of the plan.

quantity_supportedboolean

Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.

create_timestring ppaas_date_time_v3

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

update_timestring ppaas_date_time_v3

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

Changes

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