maton stripe subscription update

maton stripe subscription update <id> [flags]

Update a subscription. Use –items to add, replace, or remove items in the subscription. Each –items value is a comma-separated list of key=value pairs describing one item, where the keys mirror Stripe’s items[N][key] form fields:

price=price_xxx — add or replace by price id=si_xxx,price=price_yyy — change an existing item’s price id=si_xxx,quantity=3 — change quantity on an existing item id=si_xxx,deleted=true — remove an existing item

Repeat –items once per item.

Options

--cancel-at-period-end <string>
Set to 'true' or 'false'
--connection <string>
Connection ID to route through (Maton-Connection header)
--default-payment-method <string>
Default payment method ID
--description <string>
Description
--dry-run
Print the request that would be sent without executing it
--items <stringArray>
Subscription item spec (key=value,key=value); repeatable, one per item
-q, --jq <expression>
Filter JSON output using a jq expression
--json
Output raw JSON
--metadata <stringArray>
Metadata key=value pair (repeatable)
--paginate
Follow next_cursor and concatenate all pages (list commands only)
--proration-behavior <string>
Proration behavior (create_prorations, none, always_invoice)
-t, --template <string>
Format JSON output using a Go template; see "maton help formatting"

Options inherited from parent commands

-p, --profile <string>
Profile to use for this invocation (overrides the active profile; also reads MATON_PROFILE)

Examples

$ maton stripe subscription update sub_123 --metadata renewed=true
$ maton stripe subscription update sub_123 --cancel-at-period-end true
$ maton stripe subscription update sub_123 --items 'price=price_999,quantity=2'
$ maton stripe subscription update sub_123 --items 'id=si_abc,deleted=true' --items 'price=price_xyz'
$ maton stripe subscription update sub_123 --proration-behavior none

See also