Update delivery instructions for a subscription

PUT

/api/subscriptions/{id}/delivery-instructions

• Production server
• Development server

Updates the delivery_instructions on the subscription. When update_all_active is true, the same instructions are applied to every active subscription on the same profile and the response is the bulk-update result instead of the single subscription.

Parameters

Path Parameters

id

string

Request Body

object

delivery_instructions

required

string

nullable <= 1000 characters

update_all_active

boolean

Responses

200

Updated subscription. When update_all_active=true, returns a bulk-update result object instead.

object

data

required

object

number

required

string

id

required

string

status

required

string

Allowed values: ACTIVE PAUSED CANCELLED EXPIRED PAYMENT_FAILED

created_at

string

nullable

updated_at

string

nullable

is_active

required

boolean

account_id

required

string

can_cancel

required

boolean

profile_id

required

string

currency_code

required

string

subtotal

required

number

discount_amount

required

number

total

required

number

delivery_slot_id

string

nullable

shipping_amount

required

number

tax_amount

required

number

delivery_instructions

string

nullable

delivery_address

object

address1

string

city

string

country

string

country_code

string

zip

string

address2

One of:

string

string

string

string

phone

One of:

string

string

string

string

first_name

One of:

string

string

string

string

last_name

One of:

string

string

string

string

company

One of:

string

string

string

string

province

One of:

string

string

string

string

province_code

One of:

string

string

string

string

lines

required

Array<object>

object

shopify_contract_id

number

nullable

billing_interval

required

string

billing_interval_count

required

number

next_billing_date

string

nullable

payment_day_of_week

number

nullable

next_delivery_date

string

nullable

next_production_date

string

nullable

delivery_slot_valid

required

boolean

cancelled_at

string

nullable

cancellation_reason

string

nullable

cancellation_reason_id

string

nullable

paused_at

string

nullable

payment_method_brand

string

nullable

payment_method_last4

string

nullable

current_billing_cycle

required

number

shopify_origin_order_id

string

nullable

delivery_interval

required

string

delivery_interval_count

required

number

migration_source_ref

string

nullable

note

string

nullable

custom_attributes

object

pause_reason

string

nullable

pause_reason_id

string

nullable

discounts

Array<object>

object

id

string

status

string

Allowed values: ACTIVE EXHAUSTED REMOVED

created_at

string

nullable

updated_at

string

nullable

is_active

boolean

discount_code

string

nullable

title

string

value

number

nullable

shopify_discount_id

string

currency_code

string

nullable

target_type

string

Allowed values: ORDER SHIPPING_LINE LINE_ITEM

value_type

One of:

string

string

nullable

string

string

Allowed values: PERCENTAGE

string

string

Allowed values: FIXED_AMOUNT

recurring_cycle_limit

number

nullable

applied_at

string

nullable

exhausted_at

string

nullable

removed_at

string

nullable

is_shipping_discount

boolean

discount_label

string

last_order

string

nullable

can_pause

required

boolean

can_resume

required

boolean

can_reactivate

required

boolean

is_in_dunning

required

boolean

can_retry_payment

required

boolean

frequency_label

required

string

entity_label

string

nullable

current_dunning_episode

string

nullable

has_shipping_discount

required

boolean

total_revenue

required

number

profile

One of:

string

string

object

object

id

string

timezone

string

nullable

address1

string

nullable

address2

string

nullable

city

string

nullable

region

string

nullable

country

string

nullable

postal_code

string

nullable

created_at

string

nullable

updated_at

string

nullable

full_address

string

email_status

One of:

string

string

nullable

string

string

Allowed values: subscribed

string

string

Allowed values: unsubscribed

string

string

Allowed values: suppressed

email

string

external_id

string

nullable

first_name

string

nullable

last_name

string

nullable

full_name

string

phone_number

string

nullable

sms_status

One of:

string

string

nullable

string

string

Allowed values: subscribed

string

string

Allowed values: unsubscribed

string

string

Allowed values: suppressed

shopify_customer_id

string

nullable

delivery_day

One of:

string

string

string

string

nullable

object

object

id

string

created_at

string

nullable

updated_at

string

nullable

is_active

boolean

courier_lead_time_days

number

nullable

day_of_week

number

day_name

string

packing_day_of_week

number

nullable

billing_day_of_week

number

nullable

delivery_configuration_id

string

packing_day_name

string

nullable

billing_day_name

string

nullable

delivery_slot

One of:

string

string

string

string

nullable

object

object

id

string

created_at

string

nullable

updated_at

string

nullable

is_active

boolean

position

number

label

string

start_time

string

end_time

string

is_all_day

boolean

delivery_day_id

string

entities

One of:

string

string

Array<object>

Array<object>

object

id

string

name

string

created_at

string

nullable

updated_at

string

nullable

is_active

boolean

account_id

string

profile_id

string

image_url

string

nullable

wizard_id

string

nullable

entity_type

string

attributes

string