Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Body

application/json
groups
object[]
required

Groups of products in this collection

name
string
required

Name of the product collection

brand_id
string | null

Brand id for the collection, if not provided will default to primary brand

description
string | null

Optional description of the product collection

effective_at_on_downgrade
null | enum<string>

Default effective_at setting for subscription plan downgrades (NULL = inherit from business)

Available options:
immediately,
next_billing_date
effective_at_on_upgrade
null | enum<string>

Default effective_at setting for subscription plan upgrades (NULL = inherit from business)

Available options:
immediately,
next_billing_date
on_payment_failure
null | enum<string>

Default behavior for subscription plan changes on payment failure (NULL = inherit from business)

Available options:
prevent_change,
apply_change
proration_billing_mode_on_downgrade
null | enum<string>

Default proration billing mode for subscription plan downgrades (NULL = inherit from business)

Available options:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill
proration_billing_mode_on_upgrade
null | enum<string>

Default proration billing mode for subscription plan upgrades (NULL = inherit from business)

Available options:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill

Response

Product Collection Created Successfully

brand_id
string
required

Brand ID for the collection

created_at
string<date-time>
required

Timestamp when the collection was created

groups
object[]
required

Groups in this collection

id
string
required

Unique identifier for the product collection

name
string
required

Name of the collection

updated_at
string<date-time>
required

Timestamp when the collection was last updated

description
string | null

Description of the collection

effective_at_on_downgrade
null | enum<string>

Default effective_at setting for subscription plan downgrades (null = inherit from business)

Available options:
immediately,
next_billing_date
effective_at_on_upgrade
null | enum<string>

Default effective_at setting for subscription plan upgrades (null = inherit from business)

Available options:
immediately,
next_billing_date
image
string | null

URL of the collection image

on_payment_failure
null | enum<string>

Default behavior for subscription plan changes on payment failure (null = inherit from business)

Available options:
prevent_change,
apply_change
proration_billing_mode_on_downgrade
null | enum<string>

Default proration billing mode for subscription plan downgrades (null = inherit from business)

Available options:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill
proration_billing_mode_on_upgrade
null | enum<string>

Default proration billing mode for subscription plan upgrades (null = inherit from business)

Available options:
prorated_immediately,
full_immediately,
difference_immediately,
do_not_bill
Last modified on May 21, 2026