Platform GST

Info

Subscriptions

Active

Name :	Subscriptions
Base Path :	/undefined
Server :	https://api-m.sandbox.paypal.com
Version :	1.6
Description :	"You can use billing plans and subscriptions to create subscriptions that process recurring PayPal payments for physical or digital goods, or services. A plan includes pricing and billing cycle information that defines the amount and frequency of charge for a subscription. You can also define a fixed plan, such as a $5 basic plan or a volume- or graduated-based plan with pricing tiers based on the quantity purchased. For more information, see <a href=\"/docs/subscriptions/\">Subscriptions Overview</a>."

Operation ID:

Parent API

Name: Subscriptions

Server: https://api-m.sandbox.paypal.com

Version: 1.6

Build ID: 3726a307-a445-4ea6-9c13-c8e51f2fcd7e

Date Issues: 2024/12/26

Date Created: NAN

Note:

OperationID:	Path:	Verb:

Parameters	Path		Ref

Parameter Name	IN	Required	LINK/TYPE

Request Body	Path		Ref

Object Name	Field TYPE	PATTERN	ENUM	PARENT

Responses	Path		Ref

Success Object	Field TYPE	PATTERN	ENUM	PARENT

Paths

Optional

New Path

Select Methodes

GET

Operation ID

GET operation

POST

Operation ID

POST operations

PUT

Operation ID

Put operations

Delete

Operation ID

Delete operations

HEAD

Operation ID

HEAD operations

PATCH

Operation ID

PATCH operations

/v1/billing/plans

Request Parameters:

Approval	Name	In		Required	Schema
	Prefer	header	Active	false	Schema.type: string
	PayPal-Request-Id	header	Active	false	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json

Request Responses:

Status Code	Description	Content-Type	Schema
200:	A successful request returns the HTTP `200 OK` status code and a JSON response body that shows billing plan details.	application/json :	#/components/schemas/plan
201:	A successful request returns the HTTP `201 Created` status code and a JSON response body that shows billing plan details.	application/json :	#/components/schemas/plan
400:	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

Request Parameters:

Name	In		Required	Schema
Prefer	header	Active	false	Schema.type: string
product_id	query	Active	false	Schema.type: string
plan_ids	query	Active	false	Schema.type: string
page_size	query	Active		Schema.type: integer
page	query	Active		Schema.type: integer
total_required	query	Active		Schema.type: boolean

Request Responses:

Status Code	Description	Content-Type	Schema
200:	A successful request returns the HTTP `200 OK` status code and a JSON response body that lists billing plans.	application/json :	#/components/schemas/plan_collection
400:	Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	#/components/schemas/error_404
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/plans/{id}

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string

Request Responses:

Status Code	Description	Content-Type	Schema
200:	A successful request returns the HTTP `200 OK` status code and a JSON response body that shows plan details.	application/json :	#/components/schemas/plan
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
#/components/requestBodies/patch_request

Request Responses:

Status Code	Description	Content-Type	Schema
204:	A successful request returns the HTTP `204 No Content` status code with no JSON response body.
400:	Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/plans/{id}/activate

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
204:	A successful request returns the HTTP `204 No Content` status code with no JSON response body.
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/plans/{id}/deactivate

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
204:	A successful request returns the HTTP `204 No Content` status code with no JSON response body.
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/plans/{id}/update-pricing-schemes

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/update_pricing_schemes_list_request

Request Responses:

Status Code	Description	Content-Type	Schema
204:	A successful request returns the HTTP `204 No Content` status code with no JSON response body.
400:	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/subscriptions

Request Parameters:

Approval	Name	In		Required	Schema
	Prefer	header	Active	false	Schema.type: string
	PayPal-Request-Id	header	Active	false	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/subscription_request_post

Request Responses:

Status Code	Description	Content-Type	Schema
200:	A successful request returns the HTTP `200 OK` status code and a JSON response body that shows subscription details.	application/json :	#/components/schemas/subscription
201:	A successful request returns the HTTP `201 Created` status code and a JSON response body that shows subscription details.	application/json :	#/components/schemas/subscription
400:	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/subscriptions/{id}

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string
	fields	query	Active		Schema.type: string

Request Responses:

Status Code	Description	Content-Type	Schema
200:	A successful request returns the HTTP `200 OK` status code and a JSON response body that shows subscription details.	application/json :	#/components/schemas/subscription
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
#/components/requestBodies/patch_request

Request Responses:

Status Code	Description	Content-Type	Schema
204:	A successful request returns the HTTP `204 No Content` status code with no JSON response body.
400:	Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/subscriptions/{id}/revise

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/subscription_revise_request

Request Responses:

Status Code	Description	Content-Type	Schema
200:	A successful request returns the HTTP `200 OK` status code and a JSON response body that shows subscription details.	application/json :	#/components/schemas/subscription_revise_response
400:	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/subscriptions/{id}/suspend

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/subscription_suspend_request

Request Responses:

Status Code	Description	Content-Type	Schema
204:	A successful request returns the HTTP `204 No Content` status code with no JSON response body.
400:	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/subscriptions/{id}/cancel

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/subscription_cancel_request

Request Responses:

Status Code	Description	Content-Type	Schema
204:	A successful request returns the HTTP `204 No Content` status code with no JSON response body.
400:	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/subscriptions/{id}/activate

Request Parameters:

Approval	Name	In		Required	Schema
	id	path	Active	true	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/subscription_activate_request

Request Responses:

Status Code	Description	Content-Type	Schema
204:	A successful request returns the HTTP `204 No Content` status code with no JSON response body.
400:	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/subscriptions/{id}/capture

Request Parameters:

Approval	Name	In		Required	Schema
	PayPal-Request-Id	header	Active	false	Schema.type: string
	id	path	Active	true	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/subscription_capture_request

Request Responses:

Status Code	Description	Content-Type	Schema
200:	A successful request returns the HTTP `200 OK` status code and a JSON response body that shows subscription details.	application/json :	#/components/schemas/transaction
202:	Request Accepted.
400:	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
422:	The requested action could not be performed, semantically incorrect, or failed business validation.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

/v1/billing/subscriptions/{id}/transactions

Request Parameters:

Name	In		Required	Schema
id	path	Active	true	Schema.type: string
start_time	query	Active	true	Schema.type: string
end_time	query	Active	true	Schema.type: string

Request Responses:

Status Code	Description	Content-Type	Schema
200:	A successful request returns the HTTP `200 OK` status code and a JSON response body that shows subscription details.	application/json :	#/components/schemas/transactions_list
400:	Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.	application/json :	[object Object],[object Object]
401:	Authentication failed due to missing authorization header, or invalid authentication credentials.	application/json :	[object Object],[object Object]
403:	Authorization failed due to insufficient permissions.	application/json :	[object Object],[object Object]
404:	The specified resource does not exist.	application/json :	[object Object],[object Object]
500:	An internal server error has occurred.	application/json :	#/components/schemas/error_500
default:			#/components/responses/default

Components

Info

Subscriptions Active

Parameters

Request Body

Responses

Paths

Select Methodes

/v1/billing/plans

/v1/billing/plans/{id}

/v1/billing/plans/{id}/activate

/v1/billing/plans/{id}/deactivate

/v1/billing/plans/{id}/update-pricing-schemes

/v1/billing/subscriptions

/v1/billing/subscriptions/{id}

/v1/billing/subscriptions/{id}/revise

/v1/billing/subscriptions/{id}/suspend

/v1/billing/subscriptions/{id}/cancel

/v1/billing/subscriptions/{id}/activate

/v1/billing/subscriptions/{id}/capture

/v1/billing/subscriptions/{id}/transactions

Components

requestBodies :

securitySchemes :

responses :

schemas :

parameters :

Subscriptions

Active