Orders > Subscriptions > subscriptionsEdit
Commerce APIOrdersSubscriptionssubscriptionsEdit
subscriptionsEdit
POST:subscriptions/edit.json

Description

Edit subscription parameters.

Permission bit: "subscriptions.modify"

Topic: Subscriptions

Arguments

data: SubscriptionEdit!

Main argument for mutations.


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


subscription_id: String!

Unique subscription identifier. See also: Unique Identifiers

Example: "ss_EQzGqWoY"


Data Argument Fields

billing_address: SubscriptionParam

Which billing address to use


billing_address_id: String

Custom billing address identifier

Valid when: billing_address_id's length doesn't exceed 250 characters


custom_billing_address: AddressCreate

Custom billing address for subscription


custom_shipping_address: AddressCreate

Custom shipping address for subscription


payment_source: SubscriptionParam

Which payment source to use


payment_source_id: String

Custom shipping address identifier

Valid when: payment_source_id's length doesn't exceed 250 characters


shipping_address: SubscriptionParam

Which shipping address to use


shipping_address_id: String

Custom shipping address identifier

Valid when: shipping_address_id's length doesn't exceed 250 characters


Result

Subscription

Preview (typescript)

Loading module