Crea Collezione di Prodotti

Crea una nuova collezione di prodotti.

POST /product-collections

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const productCollection = await client.productCollections.create({
  groups: [{ products: [{ product_id: 'product_id' }] }],
  name: 'name',
});

console.log(productCollection.id);

200

{
  "brand_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "groups": [
    {
      "group_id": "<string>",
      "products": [
        {
          "addons_count": 123,
          "files_count": 123,
          "has_credit_entitlements": true,
          "id": "<string>",
          "is_recurring": true,
          "license_key_enabled": true,
          "meters_count": 123,
          "product_id": "<string>",
          "status": true,
          "description": "<string>",
          "name": "<string>",
          "price": 123,
          "price_detail": {
            "discount": 123,
            "price": 123,
            "purchasing_power_parity": true,
            "pay_what_you_want": true,
            "suggested_price": 123,
            "tax_inclusive": true
          },
          "tax_inclusive": true
        }
      ],
      "status": true,
      "group_name": "<string>"
    }
  ],
  "id": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "image": "<string>"
}

Autorizzazioni

Authorization · string · header · obbligatorio

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

Corpo

application/json

groups · object[] · obbligatorio

Groups of products in this collection

Show child attributes

name · string · obbligatorio

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)

Opzioni disponibili: immediately, next_billing_date

effective_at_on_upgrade · null | enum<string>

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

Opzioni disponibili: immediately, next_billing_date

on_payment_failure · null | enum<string>

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

Opzioni disponibili: prevent_change, apply_change

proration_billing_mode_on_downgrade · null | enum<string>

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

Opzioni disponibili: 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)

Opzioni disponibili: prorated_immediately, full_immediately, difference_immediately, do_not_bill

Risposta

200

application/json

Product Collection Created Successfully

brand_id · string · obbligatorio

Brand ID for the collection

created_at · string<date-time> · obbligatorio

Timestamp when the collection was created

groups · object[] · obbligatorio

Groups in this collection

Show child attributes

id · string · obbligatorio

Unique identifier for the product collection

name · string · obbligatorio

Name of the collection

updated_at · string<date-time> · obbligatorio

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)

Opzioni disponibili: immediately, next_billing_date

effective_at_on_upgrade · null | enum<string>

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

Opzioni disponibili: 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)

Opzioni disponibili: prevent_change, apply_change

proration_billing_mode_on_downgrade · null | enum<string>

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

Opzioni disponibili: 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)

Opzioni disponibili: prorated_immediately, full_immediately, difference_immediately, do_not_bill