Get Upgrade Path

GET

/api/:account_id/upgrade-paths/:path_id

GET

/api/:account_id/upgrade-paths/:path_id

$ curl https://app.paymentkit.com/api/account_id/upgrade-paths/path_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "path_987654321",
3   "account_id": "acct_123456789",
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_1001",
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           "currency": "USD",
20           "amount": 1999,
21           "billing_cycle": "monthly"
22         }
23       ]
24     }
25   ],
26   "deleted_at": null
27 }

Get an upgrade path by ID.

Authentication

AuthorizationBearer

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

Path parameters

path_idstringRequired

account_idstringRequired

Query parameters

include_deletedbooleanOptionalDefaults to false

Include soft-deleted paths

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