---
title: Subscriptions v1
canonical: https://developer.paypal.com/api/subscriptions/v1
openapi_schema:
  json: https://developer.paypal.com/api/subscriptions/v1/schema.json
  yaml: https://developer.paypal.com/api/subscriptions/v1/schema.yaml
---

# Subscriptions v1 (/api/subscriptions/v1)

> This is an API reference page. The information below is a summary — the [JSON](https://developer.paypal.com/api/subscriptions/v1/schema.json) and [YAML](https://developer.paypal.com/api/subscriptions/v1/schema.yaml) schema are the preferred, authoritative source for exact parameters, request/response shapes, and validation rules.

## Base URL(s)

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

## Authentication

- Oauth2 (OAuth 2.0, clientCredentials)

## Operations

### plans

- `GET` [List plans](/api/subscriptions/v1/plans-list): Lists billing plans.
- `POST` [Create plan](/api/subscriptions/v1/plans-create): Creates a plan that defines pricing and billing cycle details for subscriptions.
- `GET` [Show plan details](/api/subscriptions/v1/plans-get): Shows details for a plan, by ID.
- `PATCH` [Update plan](/api/subscriptions/v1/plans-patch): Updates a plan with the `CREATED` or `ACTIVE` status.
- `POST` [Activate plan](/api/subscriptions/v1/plans-activate): Activates a plan, by ID.
- `POST` [Deactivate plan](/api/subscriptions/v1/plans-deactivate): Deactivates a plan, by ID.
- `POST` [Update pricing](/api/subscriptions/v1/plans-update-pricing-schemes): Updates pricing for a plan.

### subscriptions

- `GET` [List subscriptions](/api/subscriptions/v1/subscriptions-list): List all subscriptions for merchant account.
- `POST` [Create subscription](/api/subscriptions/v1/subscriptions-create): Creates a subscription.
- `GET` [Show subscription details](/api/subscriptions/v1/subscriptions-get): Shows details for a subscription, by ID.
- `PATCH` [Update subscription](/api/subscriptions/v1/subscriptions-patch): Updates a subscription which could be in ACTIVE or SUSPENDED status.
- `POST` [Revise plan or quantity of subscription](/api/subscriptions/v1/subscriptions-revise): Updates the quantity of the product or service in a subscription.
- `POST` [Suspend subscription](/api/subscriptions/v1/subscriptions-suspend): Suspends the subscription.
- `POST` [Cancel subscription](/api/subscriptions/v1/subscriptions-cancel): Cancels the subscription.
- `POST` [Activate subscription](/api/subscriptions/v1/subscriptions-activate): Activates the subscription.
- `POST` [Capture authorized payment on subscription](/api/subscriptions/v1/subscriptions-capture): Captures an authorized payment from the subscriber on the subscription.
- `GET` [List transactions for subscription](/api/subscriptions/v1/subscriptions-transactions): Lists transactions for a subscription.

## Full schema

The list above is a summary. Full parameter, request, and response detail for every operation lives in the schema: [JSON](https://developer.paypal.com/api/subscriptions/v1/schema.json) · [YAML](https://developer.paypal.com/api/subscriptions/v1/schema.yaml)