Skip to main content
PATCH

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Path Parameters

id
string<uuid>
required

Public UUID of an owned subscription.

Body

application/json

One or more safe top-level subscription fields. Query parameters and unknown fields are rejected.

Safe subscription edits. Omitted fields retain their current values. References use public UUIDs.

payment_method_id
string<uuid>
required

A saved payment method owned by the member or available through their shared wallet. Isolated companies require a company-local owned method.

address_id
string<uuid>

An owned saved address in the subscription's existing country. Country changes require cancellation and recreation.

quantity
integer

Units per cycle, subject to the variant's subscription quantity cap.

Required range: 1 <= x <= 2147483647
next_bill_date
string<date>

A date strictly after today in the subscription's timezone. Preserves billing time of day and aligned shipping. Maximum two years for yearly plans, twelve months otherwise.

confirm_early_order
boolean

The shopper's acknowledgement that an earlier next_bill_date places and charges a new order. Required for a shopper write that moves the date earlier than the scheduled one; without it the write is refused with meta.code early_order_confirmation_required.

auto_apply_points
boolean
required if auto_apply_points_scope = bundle

Opt in or out of automatically applying points on renewal. Requires an actual JSON boolean.

auto_apply_points_scope
enum<string>
default:subscription

Apply the points flag to this subscription or atomically to its renewal bundle. Payment and quantity edits always affect only the target. Bundle scope forbids address and date edits.

Available options:
subscription,
bundle
backup_cards_enabled
boolean

Turn backup cards on or off for the member at this company. When a renewal is declined, Fluid then charges the member's default card, then their other saved cards. The choice is stored on the member, not on the subscription, so it covers every subscription they have at the company and changed_ids is empty. Requires an actual JSON boolean and must be sent on its own. Turning it on is refused with 422 while backup_cards_available is false; turning it off always succeeds, so a member can withdraw even while the company does not offer backup cards.

Response

Updated subscription detail and the public UUIDs covered and changed by the edit.

Refreshed detail plus public IDs covered and changed by the edit. No-op edits have an empty changed_ids array.

status
integer
required

HTTP response status.

data
object
required

A subscription with its billed items, shipping, payment method, discounts and bundle.

meta
object
required

Envelope metadata present on every response.