Create Upgrade Path

POST

/api/:account_id/upgrade-paths/

POST

/api/:account_id/upgrade-paths/

$ curl -X POST https://app.paymentkit.com/api/account_id/upgrade-paths/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Premium Upgrade Path",
>   "products": [
>     {
>       "product_id": "prod_abc123",
>       "rank": 1
>     },
>     {
>       "product_id": "prod_def456",
>       "rank": 2
>     }
>   ]
> }'

1 {
2   "id": "upgpath_789xyz",
3   "account_id": "acct_456def",
4   "name": "Premium Upgrade Path",
5   "movement_rule": "sequential",
6   "created_at": "2024-01-15T09:30:00Z",
7   "updated_at": "2024-01-15T09:30:00Z",
8   "is_active": true,
9   "products": [
10     {
11       "id": "upprod_001",
12       "product_id": "prod_abc123",
13       "product_name": "Basic Plan",
14       "rank": 1,
15       "created_at": "2024-01-15T09:30:00Z",
16       "updated_at": "2024-01-15T09:30:00Z",
17       "prices": [
18         {}
19       ]
20     },
21     {
22       "id": "upprod_002",
23       "product_id": "prod_def456",
24       "product_name": "Premium Plan",
25       "rank": 2,
26       "created_at": "2024-01-15T09:30:00Z",
27       "updated_at": "2024-01-15T09:30:00Z",
28       "prices": [
29         {}
30       ]
31     }
32   ],
33   "deleted_at": "null"
34 }

Create a new upgrade path.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Request

This endpoint expects an object.

namestringRequired

Name of the upgrade path

productslist of objectsRequired

Products with their ranks

movement_ruleenumOptionalDefaults to sequential

Movement rule: sequential or flexible

is_activebooleanOptionalDefaults to true

Whether the path is active

Response

Successful Response

idstring

account_idstring

namestring

movement_rulestring

created_atdatetime

updated_atdatetime

is_activebooleanOptionalDefaults to true

productslist of objectsOptional

deleted_atdatetime or nullOptional

Errors

422

Unprocessable Entity Error