更新产品集合

更新产品集合的详细信息。

PATCH /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
});

await client.productCollections.update('id');

授权

Authorization · string · header · 必填

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

路径参数

id · string · 必填

Product Collection Id

请求体

application/json

brand_id · string | null

Optional brand_id update

description · string | null

Optional description update - pass null to remove, omit to keep unchanged

effective_at_on_downgrade · null | enum<string>

Effective_at setting for downgrades: Some(Some(val)) = set, Some(None) = clear (inherit), None = no change

可用选项: immediately, next_billing_date

effective_at_on_upgrade · null | enum<string>

Effective_at setting for upgrades: Some(Some(val)) = set, Some(None) = clear (inherit), None = no change

可用选项: immediately, next_billing_date

group_order · string<uuid>[] | null

Optional new order for groups (array of group UUIDs in desired order)

image_id · string<uuid> | null

Optional image update - pass null to remove, omit to keep unchanged

name · string | null

Optional new name for the collection

on_payment_failure · null | enum<string>

On payment failure behavior: Some(Some(val)) = set, Some(None) = clear (inherit), None = no change

可用选项: prevent_change, apply_change

proration_billing_mode_on_downgrade · null | enum<string>

Proration billing mode for downgrades: Some(Some(val)) = set, Some(None) = clear (inherit), None = no change

可用选项: prorated_immediately, full_immediately, difference_immediately, do_not_bill

proration_billing_mode_on_upgrade · null | enum<string>

Proration billing mode for upgrades: Some(Some(val)) = set, Some(None) = clear (inherit), None = no change

可用选项: prorated_immediately, full_immediately, difference_immediately, do_not_bill

响应

200

Product Collection Updated Successfully