# Subscriptions API

> Subscriptions API on Apizie: 16 endpoints (List plans, Create plan, Show plan details, Update plan, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:paypal-subscriptions/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:paypal-subscriptions`
- Category: Payments
- Status: byok
- Source: https://paypal
- Page: https://apizie.tech/api/payments/paypal-subscriptions
- OpenAPI: https://apizie.tech/api/payments/paypal-subscriptions/openapi.json

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…

## Endpoints

### List plans
`GET https://apizie.tech/v1/payments:paypal-subscriptions/plans-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Prefer | string | no | The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response… |
| product_id | string | no | Filters the response by a Product ID. |
| page_size | integer | no | The number of items to return in the response. |
| page | integer | no | A non-zero integer which is the start index of the entire list of items to return in the response. The combination of `page=1` and… |
| total_required | boolean | no | Indicates whether to show the total count in the response. |

### Create plan
`POST https://apizie.tech/v1/payments:paypal-subscriptions/plans-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Prefer | string | no | The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response… |
| PayPal-Request-Id | string | no | The server stores keys for 72 hours. |
| body | object | no | JSON request body |

### Show plan details
`GET https://apizie.tech/v1/payments:paypal-subscriptions/plans-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |

### Update plan
`POST https://apizie.tech/v1/payments:paypal-subscriptions/plans-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |
| body | object | no | JSON request body |

### Activate plan
`POST https://apizie.tech/v1/payments:paypal-subscriptions/plans-activate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |

### Deactivate plan
`POST https://apizie.tech/v1/payments:paypal-subscriptions/plans-deactivate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |

### Update pricing
`POST https://apizie.tech/v1/payments:paypal-subscriptions/plans-update-pricing-schemes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |
| body | object | no | JSON request body |

### Create subscription
`POST https://apizie.tech/v1/payments:paypal-subscriptions/subscriptions-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Prefer | string | no | The preferred server response upon successful completion of the request. Value is: return=minimal . The server returns a minimal response… |
| PayPal-Request-Id | string | no | The server stores keys for 72 hours. |
| body | object | no | JSON request body |

### Show subscription details
`GET https://apizie.tech/v1/payments:paypal-subscriptions/subscriptions-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |
| fields | string | no | List of fields that are to be returned in the response. Possible value for fields are last_failed_payment and plan. |

### Update subscription
`POST https://apizie.tech/v1/payments:paypal-subscriptions/subscriptions-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |
| body | object | no | JSON request body |

### Revise plan or quantity of subscription
`POST https://apizie.tech/v1/payments:paypal-subscriptions/subscriptions-revise` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |
| body | object | no | JSON request body |

### Suspend subscription
`POST https://apizie.tech/v1/payments:paypal-subscriptions/subscriptions-suspend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |
| body | object | no | JSON request body |

### Cancel subscription
`POST https://apizie.tech/v1/payments:paypal-subscriptions/subscriptions-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |
| body | object | no | JSON request body |

### Activate subscription
`POST https://apizie.tech/v1/payments:paypal-subscriptions/subscriptions-activate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |
| body | object | no | JSON request body |

### Capture authorized payment on subscription
`POST https://apizie.tech/v1/payments:paypal-subscriptions/subscriptions-capture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PayPal-Request-Id | string | no | The server stores keys for 72 hours. |
| id | string | yes | The ID of the subscription. |
| body | object | no | JSON request body |

### List transactions for subscription
`GET https://apizie.tech/v1/payments:paypal-subscriptions/subscriptions-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the subscription. |
| start_time | string | yes | The start time of the range of transactions to list. |
| end_time | string | yes | The end time of the range of transactions to list. |

## Example
```
curl "https://apizie.tech/v1/payments:paypal-subscriptions/plans-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Subscriptions API?
Create a free Apizie key, then send GET https://apizie.tech/v1/payments:paypal-subscriptions/plans-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Subscriptions API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Subscriptions itself also needs your own key from paypal.

### Can AI agents use the Subscriptions API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:paypal-subscriptions.

### What is the status of the Subscriptions API?
Needs your own provider key (bring your own key)