Produktkollektion abrufen

Detaillierte Informationen über eine spezifische Produktkollektion abrufen.

GET /product-collections/{id}

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.retrieve('id');

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>"
}

Autorisierungen

Authorization · string · header · erforderlich

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

Pfadparameter

id · string · erforderlich

Product Collection Id

Antwort

200

application/json

Product Collection Retrieved Successfully

brand_id · string · erforderlich

Brand ID for the collection

created_at · string<date-time> · erforderlich

Timestamp when the collection was created

groups · object[] · erforderlich

Groups in this collection

Show child attributes

id · string · erforderlich

Unique identifier for the product collection

name · string · erforderlich

Name of the collection

updated_at · string<date-time> · erforderlich

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)

Verfügbare Optionen: immediately, next_billing_date

effective_at_on_upgrade · null | enum<string>

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

Verfügbare Optionen: 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)

Verfügbare Optionen: prevent_change, apply_change

proration_billing_mode_on_downgrade · null | enum<string>

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

Verfügbare Optionen: 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)

Verfügbare Optionen: prorated_immediately, full_immediately, difference_immediately, do_not_bill