subscriptions
subscriptions

Update Subscription

patch/api/v1/subscriptions/{subscription_id}

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/subscriptions/{subscription_id}
  • Auth: API key in header X-API-Key

Path parameters

subscription_idstring uuid required

Request body

namestring nullable
scheduleobject nullable
pricingobject nullable
billing_mode'card' | 'invoice' | 'none' nullable
offer_codestring nullable
capobject nullable
lane'all' | 'best' | 'contact' nullable
delivery_method'file' | 'crm' nullable
connection_idstring uuid nullable
buyer_emailstring nullable
floor_created_atstring date-time nullable
status'active' | 'paused' | 'canceled' nullable
customer_idstring uuid nullable
billing_status'none' | 'active' | 'past_due' | 'canceled' nullable
max_age_daysinteger nullable
notify_emptyboolean nullable
recipientsstring[] nullable

Response

Successful Response

subscription_idstring uuid required
namestring required
statusstring required
buyer_emailstring nullable
customer_idstring uuid nullable required
saved_list_idstring nullable
scheduleobject nullable
schedule_wordsstring nullable
pricingobject nullable
billing_modestring
billing_statusstring
offer_codestring nullable
credits_remaining_centsinteger nullable
unbilled_centsinteger
capobject nullable
lanestring nullable
delivery_methodstring
connection_idstring uuid nullable required
floor_created_atstring date-time nullable
max_age_daysinteger nullable
notify_emptyboolean
recipientsstring[] nullable
next_delivery_atstring date-time nullable
last_run_atstring date-time nullable required
last_errorstring nullable
retry_afterstring date-time nullable
manage_urlstring nullable
created_atstring date-time nullable required
stripe_subscription_idstring nullable
stripe_customer_idstring nullable
stripe_price_idstring nullable
current_period_endstring date-time nullable
healthstring nullable
cadencestring required
cap_cents_per_deliveryinteger nullable
high_water_markstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.