A subscription is upgraded or downgraded

Webhook

This event occurs when a package is upgraded or downgraded (i.e. a line on the package is added, removed, or changed in any way)

Note these fields:

context_str = package
context_id = ... (this will be the package_id of the package)
event = upgrade

Request

application/json

Body

context_str string

context_id integer

event string

data

object

package

object

package_id integer

customer_id integer

brand_id integer

brand_name string

class_id integer

class_name string

external_key string

token string

nickname string

paymethod string

paymethod_name string

paymethod_detail string

creditcard_id integer

ach_id integer

tokenized_id integer

admin_id integer

admin_name string

bill_addr1 string

bill_addr2 string

bill_addr3 string

bill_city string

bill_state string

bill_postcode string

bill_country string

bill_notes string

ship_addr1 string

ship_addr2 string

ship_addr3 string

ship_city string

ship_state string

ship_postcode string

ship_country string

ship_notes string

memo string

currency_id integer

currency_iso4217 string

currency_symbol string

amount_collected float

amount_invoiced float

amount_due float

amount_overdue float

suspendfrom_datetime string

suspendto_datetime string

next_invoice_datetime string

is_overdue boolean

days_overdue integer

start_datetime string

cancel_datetime string

write_datetime string

mod_datetime string

holduntil_datetime string

package_status_id integer

package_status_name string

package_status_str string

package_status_state string

mrr float

arr float

cancel_reason string

terms_id integer

terms_name string

terms_days integer

paycycle string

paycycle_name string

custom_1 string

custom_2 string

custom_3 string

custom_4 string

custom_5 string

custom_6 string

custom_7 string

custom_8 string

custom_9 string

custom_10 string

custom_11 string

custom_12 string

custom_13 string

custom_14 string

custom_15 string

custom_16 string

custom_17 string

custom_18 string

custom_19 string

custom_20 string

first_invoice_schedule_template_id integer

recurring_invoice_schedule_template_id integer

line_items array

tags string[]

url_self string

customer

object

customer_id integer

parent_customer_id integer

token string

superuser_id integer

external_key string

display_as string

company string

language_id integer

currency_id integer

currency_iso4217 string

currency_symbol string

class_id integer

admin_id integer

campaign_id integer

campaign_details string

superuser_username string

superuser_email string

superuser_name string

superuser_first_name string

superuser_last_name string

superuser_phone string

superuser_token string

superuser_title string

bill_addr1 string

bill_addr2 string

bill_addr3 string

bill_city string

bill_state string

bill_postcode string

bill_country string

bill_block string

ship_addr1 string

ship_addr2 string

ship_addr3 string

ship_city string

ship_state string

ship_postcode string

ship_country string

ship_block string

custom_1 string

custom_2 string

custom_3 string

custom_4 string

custom_5 string

custom_6 string

custom_7 string

custom_8 string

custom_9 string

custom_10 string

custom_11 string

custom_12 string

custom_13 string

custom_14 string

custom_15 string

custom_16 string

custom_17 string

custom_18 string

custom_19 string

custom_20 string

write_datetime string

write_ipaddr string

mod_datetime string

mod_ipaddr string

brand_id integer

class_name string

terms_id integer

terms_name string

terms_days integer

url_statementlink string

url_paymethodlink string

url_self string

admin_name string

admin_email string

customer_status_id integer

customer_status_name string

customer_status_str string

customer_status_state string

default_paymethod string

default_creditcard_id integer

default_ach_id integer

no_taxes boolean

no_dunning boolean

no_latefees boolean

no_procfees boolean

invoice_delivery string

Possible values: [print, email]

dunning_delivery string

Possible values: [print, email]

tax_ident string

total float

balance float

paid float

mrr float

arr float

tags string[]

user

object

user_id integer

external_key string

token string

username string

password string

name string

first_name string

middle_name_glob string

last_name string

name_suffix string

display_as string

title string

email string

phone string

mobile string

user_type_id integer

user_type_name string

customer_id integer

custom_1 string

custom_2 string

custom_3 string

custom_4 string

custom_5 string

custom_6 string

custom_7 string

custom_8 string

custom_9 string

custom_10 string

custom_11 string

custom_12 string

custom_13 string

custom_14 string

custom_15 string

custom_16 string

custom_17 string

custom_18 string

custom_19 string

custom_20 string

write_datetime string

mod_datetime string

url_self string

old_line_item

object

line_item_id integer

package_id integer

external_key string

item_id integer

admin_id integer

item_name string

item_external_key string

item_accounting_sku string

item_token string

item_units float

item_type string

item_is_usage bool

line_item_bundle_id integer

tierset_id integer

nickname string

descrip string

trial_days integer

trial_units float

trial_recurs integer

expire_datetime string

expire_recurs integer

line_quantity float

subscribe_datetime string

subscribe_prorate_from_datetime string

subscribe_prorate_to_datetime string

cancel_datetime string

custom_1 string

custom_2 string

custom_3 string

custom_4 string

custom_5 string

custom_6 string

custom_7 string

custom_8 string

custom_9 string

custom_10 string

custom_11 string

custom_12 string

custom_13 string

custom_14 string

custom_15 string

custom_16 string

custom_17 string

custom_18 string

custom_19 string

custom_20 string

tierset

object

tierset_id integer

currency_id integer

setup number

base number

minimum number

percent number

paycycle string

pricemodel string

write_datetime string

mod_datetime string

currency_symbol string

currency_iso4217 string

setup_formatted string

base_formatted string

minimum_formatted string

percent_formatted string

pricemodel_desc string

tiers object

new_line_item

object

line_item_id integer

package_id integer

external_key string

item_id integer

admin_id integer

item_name string

item_external_key string

item_accounting_sku string

item_token string

item_units float

item_type string

item_is_usage bool

line_item_bundle_id integer

tierset_id integer

nickname string

descrip string

trial_days integer

trial_units float

trial_recurs integer

expire_datetime string

expire_recurs integer

line_quantity float

subscribe_datetime string

subscribe_prorate_from_datetime string

subscribe_prorate_to_datetime string

cancel_datetime string

custom_1 string

custom_2 string

custom_3 string

custom_4 string

custom_5 string

custom_6 string

custom_7 string

custom_8 string

custom_9 string

custom_10 string

custom_11 string

custom_12 string

custom_13 string

custom_14 string

custom_15 string

custom_16 string

custom_17 string

custom_18 string

custom_19 string

custom_20 string

tierset

object

tierset_id integer

currency_id integer

setup number

base number

minimum number

percent number

paycycle string

pricemodel string

write_datetime string

mod_datetime string

currency_symbol string

currency_iso4217 string

setup_formatted string

base_formatted string

minimum_formatted string

percent_formatted string

pricemodel_desc string

tiers object

security_token string

Responses

Return a 200 status to indicate that the data was received successfully

A subscription is upgraded or downgraded

Request​

Body

Responses​

Request

Responses