Create Package

POST

/api/:account_id/packages/

POST

/api/:account_id/packages/

$ curl -X POST https://app.paymentkit.com/api/account_id/packages/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Premium Starter Package"
> }'

1 {
2   "id": "pkg_9f8b7c6d5e4a3b2c1d0e",
3   "account_id": "acct_1234567890abcdef",
4   "name": "Premium Starter Package",
5   "created_at": "2024-01-15T09:30:00Z",
6   "updated_at": "2024-01-15T09:30:00Z",
7   "description": "A curated package including our top-selling products with flexible billing options.",
8   "is_active": true,
9   "allow_monthly": true,
10   "allow_annual": true,
11   "default_billing_cycle": "monthly",
12   "items": [
13     {
14       "id": "item_abcdef1234567890",
15       "package_id": "pkg_9f8b7c6d5e4a3b2c1d0e",
16       "product_id": "prod_0011223344556677",
17       "created_at": "2024-01-15T09:30:00Z",
18       "updated_at": "2024-01-15T09:30:00Z",
19       "product_name": "Cloud Storage Pro",
20       "prices": [
21         {
22           "price_id": "price_monthly_001",
23           "is_default": true,
24           "name": "Monthly Subscription",
25           "unit_amount_atom": 9999,
26           "currency": "usd",
27           "recurring_interval": "month",
28           "recurring_interval_count": 1,
29           "billing_scheme": "per_unit",
30           "usage_type": "licensed"
31         },
32         {
33           "price_id": "price_annual_001",
34           "is_default": false,
35           "name": "Annual Subscription",
36           "unit_amount_atom": 99999,
37           "currency": "usd",
38           "recurring_interval": "year",
39           "recurring_interval_count": 1,
40           "billing_scheme": "per_unit",
41           "usage_type": "licensed"
42         }
43       ],
44       "monthly_price_id": "price_monthly_001",
45       "annual_price_id": "price_annual_001",
46       "quantity": 1,
47       "description": "Access to 1TB of cloud storage with premium support."
48     }
49   ],
50   "deleted_at": "2024-01-15T09:30:00Z"
51 }

Create a new package with items. A package groups products for checkout with billing cycle toggles. At least one item is required, and at least one billing cycle must be enabled.

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>=1 character

Package name

descriptionstring or nullOptional

Package description

is_activebooleanOptionalDefaults to true

Whether the package is active

allow_monthlybooleanOptionalDefaults to true

Allow monthly billing cycle

allow_annualbooleanOptionalDefaults to true

Allow annual billing cycle

default_billing_cycleenumOptionalDefaults to monthly

Default billing cycle when both are allowed

itemslist of objectsOptional

Package items (can be added after creation)

metadatamap from strings to any or nullOptional

Optional metadata

Response

Successful Response

idstring

account_idstring

namestring

created_atdatetime

updated_atdatetime

descriptionstring or nullOptional

is_activebooleanOptionalDefaults to true

allow_monthlybooleanOptionalDefaults to true

allow_annualbooleanOptionalDefaults to true

default_billing_cyclestringOptionalDefaults to monthly

itemslist of objectsOptional

deleted_atdatetime or nullOptional

Errors

422

Unprocessable Entity Error