Refer to the Webhooks Reference article for related trigger events.
billing_date_change payload
{"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"subscription"=>
{"id"=>16372192,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Mon, 13 Feb 2017 11:50:57 EST -05:00,
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 13:39:20 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>Thu, 13 Apr 2017 14:28:00 EDT -04:00,
"next_assessment_at"=>Thu, 13 Apr 2017 14:28:00 EDT -04:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 13 Feb 2017 13:28:05 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>173961106,
"signup_revenue"=>"60.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>22000,
"product_price_in_cents"=>5000,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"cz8wdq",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"customer"=>
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"organization"=>"Acme",
"email"=>"doris@example.com",
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"reference"=>"123456789",
"address"=>"123 Anywhere Street",
"address_2"=>"",
"city"=>"Boston",
"state"=>"MA",
"zip"=>"02120",
"country"=>"US",
"phone"=>"555-555-1212",
"portal_invite_last_sent_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"portal_invite_last_accepted_at"=>nil,
"verified"=>nil,
"portal_customer_created_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil},
"product"=>
{"id"=>4442358,
"name"=>"Gold Product",
"handle"=>"gold-product",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Thu, 15 Dec 2016 09:32:36 EST -05:00,
"updated_at"=>Thu, 15 Dec 2016 09:32:36 EST -05:00,
"price_in_cents"=>5000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>306012,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/7dbsnjd8t8cx/gold-product"},
{"id"=>310598,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/ksjh9py5fn5h/gold-product"},
{"id"=>311132,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/kjmks49g8d3d/gold-product"}]},
"credit_card"=>
{"id"=>10914352,
"first_name"=>"Doris",
"last_name"=>"Tester",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>2,
"expiration_year"=>2018,
"customer_id"=>15826583,
"current_vault"=>"bogus",
"vault_token"=>"1",
"billing_address"=>"",
"billing_city"=>"",
"billing_state"=>"",
"billing_zip"=>"",
"billing_country"=>"",
"customer_vault_token"=>nil,
"billing_address_2"=>"",
"payment_type"=>"credit_card"},
"previous_billing_date"=>Mon, 13 Mar 2017 14:28:05 EDT -04:00},
"event_id"=>377604301}Back to list of Payload Examples
component_allocation_change payload
If a payment is attempted at the time of the allocation, sites will show the result in the webhook payload.
On/Off Component Change
"component"=>
{"id"=>375117,
"kind"=>"on_off_component",
"name"=>"Cancellation fee",
"unit_name"=>"on/off"},
"subscription"=>{"id"=>16372192, "name"=>"Doris Tester"},
"product"=>{"id"=>4443536, "name"=>"Business Monthly"},
"memo"=>"Adding cancellation fee for Doris",
"timestamp"=>"2017-02-13T18:46:49Z",
"previous_allocation"=>0,
"new_allocation"=>1,
"payment"=>nil,
"event_id"=>377608723}Quantity-based Component Change
"component"=>
{"id"=>375250,
"kind"=>"quantity_based_component",
"name"=>"Quantity Component",
"unit_name"=>"Quantity Component"},
"subscription"=>{"id"=>16372192, "name"=>"Doris Tester"},
"product"=>{"id"=>4443536, "name"=>"Business Monthly"},
"memo"=>"Adding 90 components for Doris",
"timestamp"=>"2017-02-13T18:49:58Z",
"previous_allocation"=>10,
"new_allocation"=>90,
"payment"=>
{"id"=>1078634,
"success"=>true,
"amount_in_cents"=>800,
"memo"=>"Payment for: Full-price component allocation changes."},
"event_id"=>377609562}Prepaid Component Change
"component"=>
{"id"=>957864,
"kind"=>"prepaid_usage_component",
"name"=>"Minutes",
"unit_name"=>"minutes",
"handle"=>nil},
"subscription"=>
{"id"=>32304660,
"name"=>"Mario Smith",
"organization"=>"",
"state"=>"active",
"product"=>
{"id"=>4607690,
"product_price_point_id"=>322106,
"product_price_point_handle"=>"uuid:8e1f3840-c44a-0136-fd09-02d0e580fd36",
"name"=>"v-1",
"interval"=>1,
"interval_unit"=>"month"}},
"product"=>
{"id"=>4607690,
"name"=>"Silver Plan",
"interval"=>1,
"interval_unit"=>"month"},
"allocation"=>
{"id"=>571895482,
"proration_upgrade_scheme"=>"full-price-attempt-capture",
"proration_downgrade_scheme"=>"no-prorate"},
"previous_allocation"=>0,
"new_allocation"=>10,
"memo"=>"",
"timestamp"=>"2020-04-28T18:34:28Z",
"price_point_id"=>821647,
"payment"=>
{"id"=>381732923,
"success"=>true,
"amount_in_cents"=>2000,
"memo"=>"Payment for: Full-price component allocation changes."},
"allocated_quantity"=>10,
"expires_at"=>nil,
"renews"=>true,
"total_used"=>0,
"total_overage"=>0,
"event_id"=>1064815277}Back to list of Payload Examples
custom_field_value_change payload
{"site"=>{"id"=>60050, "subdomain"=>"chargify-sandbox-141"},
"metafield"=>
{"event_type"=>"created",
"metafield_name"=>"Device ID",
"metafield_id"=>31483,
"old_value"=>nil,
"new_value"=>"dev_7hbd)jh27gyJ",
"resource_type"=>"Subscription",
"resource_id"=>63081463},
"event_id"=>2946240555}
Back to list of Payload Examples
customer_create payload
{"address"=>"123 Main St",
"address_2"=>"Apt 123",
"city"=>"Pleasantville",
"country"=>"US",
"created_at"=>"2012-09-09 11:38:32 -0400",
"email"=>"john@example.com",
"first_name"=>"John",
"id"=>"0",
"last_name"=>"Doe",
"organization"=>"Acme, Inc.",
"phone"=>"555-555-1234",
"reference"=>"johndoe",
"state"=>"NC",
"updated_at"=>"2012-09-09 11:38:32 -0400",
"zip"=>"12345",
"parent_id"=>nil},
"site"=>{"id"=>2, "subdomain"=>"acme"},
"event_id"=>855147013}Back to list of Payload Examples
customer_delete payload
{"customer"=>
{"id"=>59200671,
"first_name"=>"Harrison",
"last_name"=>"Ankunding",
"organization"=>"Jacobs and Sons",
"email"=>"Mellie.Lindgren80@example.org",
"created_at"=>Fri, 07 Oct 2022 12:53:42 PDT -07:00,
"updated_at"=>Fri, 07 Oct 2022 12:53:58 PDT -07:00,
"reference"=>nil,
"address"=>"303 Mozell Summit",
"address_2"=>"Suite 602",
"city"=>"East Emie",
"state"=>"CO",
"zip"=>"25924",
"country"=>"US",
"phone"=>"484-328-6314",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>Fri, 07 Oct 2022 12:53:58 PDT -07:00,
"vat_number"=>nil,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"site"=>{"id"=>60050, "subdomain"=>"chargify-sandbox-141"},
"event_id"=>2946257113}
Back to list of Payload Examples
customer_update payload
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"organization"=>"Acme",
"email"=>"doristester@example.com",
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 13:42:07 EST -05:00,
"reference"=>"123456789",
"address"=>"123 Anywhere Street",
"address_2"=>"",
"city"=>"Boston",
"state"=>"MA",
"zip"=>"02120",
"country"=>"US",
"phone"=>"555-555-1212",
"portal_invite_last_sent_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"portal_invite_last_accepted_at"=>Mon, 13 Feb 2017 12:50:55 EST -05:00,
"verified"=>false,
"portal_customer_created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"vat_number"=>737291901,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>7
},
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"event_id"=>377607274}Back to list of Payload Examples
delayed_subscription_creation_failure payload
{"subscription"=>
{"id"=>63126445,
"state"=>"pending",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>nil,
"created_at"=>Fri, 10 Mar 2023 09:19:03 PST -08:00,
"updated_at"=>Fri, 10 Mar 2023 09:19:03 PST -08:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>nil,
"next_assessment_at"=>nil,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"next_product_handle"=>nil,
"cancel_at_end_of_period"=>nil,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Fri, 10 Mar 2023 09:19:03 PST -08:00,
"previous_state"=>"pending",
"signup_payment_id"=>0,
"signup_revenue"=>"0.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>0,
"product_price_in_cents"=>10000,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"4t9cnw",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>nil,
"payer_id"=>64300587,
"receives_invoice_emails"=>nil,
"product_price_point_id"=>898846,
"next_product_price_point_id"=>nil,
"credit_balance_in_cents"=>0,
"prepayment_balance_in_cents"=>0,
"net_terms"=>nil,
"stored_credential_transaction_id"=>nil,
"locale"=>nil,
"reference"=>nil,
"currency"=>"USD",
"on_hold_at"=>nil,
"scheduled_cancellation_at"=>nil,
"prepaid_dunning"=>false,
"product_price_point_type"=>"default",
"dunning_communication_delay_enabled"=>false,
"dunning_communication_delay_time_zone"=>nil,
"customer"=>
{"id"=>64300587,
"first_name"=>"Summer",
"last_name"=>"Bayer",
"organization"=>"Fay - Rowe",
"email"=>"Carolyn.Gutmann@example.net",
"created_at"=>Fri, 10 Mar 2023 09:18:29 PST -08:00,
"updated_at"=>Fri, 10 Mar 2023 09:18:29 PST -08:00,
"reference"=>nil,
"address"=>"407 Bogisich Roads",
"address_2"=>"Suite 406",
"city"=>"New Daniella",
"state"=>"IA",
"state_name"=>"Iowa",
"zip"=>"17933",
"country"=>"US",
"country_name"=>"United States",
"phone"=>"964-327-5176",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"vat_number"=>nil,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"product"=>
{"id"=>5209515,
"name"=>"Bronze Plan",
"handle"=>"bronze_plan",
"description"=>"my description",
"accounting_code"=>nil,
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>nil,
"created_at"=>Fri, 13 Mar 2020 14:32:26 PDT -07:00,
"updated_at"=>Fri, 13 Mar 2020 14:32:26 PDT -07:00,
"price_in_cents"=>10000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>nil,
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>nil,
"taxable"=>false,
"update_return_url"=>nil,
"tax_code"=>nil,
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>nil,
"default_product_price_point_id"=>898846,
"request_billing_address"=>false,
"require_billing_address"=>false,
"require_shipping_address"=>false,
"use_site_exchange_rate"=>true,
"item_category"=>nil,
"product_price_point_id"=>898846,
"product_price_point_name"=>"Original",
"product_price_point_handle"=>"uuid:0edd1580-47a0-0138-6907-060451d6a6ae",
"product_family"=>
{"id"=>1513518,
"name"=>"import test",
"description"=>"",
"handle"=>"import-test",
"accounting_code"=>nil,
"created_at"=>Wed, 11 Mar 2020 09:45:14 PDT -07:00,
"updated_at"=>Wed, 11 Mar 2020 09:45:14 PDT -07:00},
"public_signup_pages"=>[]},
"credit_card"=>
{"id"=>50327544,
"first_name"=>"Gus",
"last_name"=>"Terry",
"masked_card_number"=>"XXXX-XXXX-XXXX-3",
"card_type"=>"bogus",
"expiration_month"=>3,
"expiration_year"=>2024,
"customer_id"=>64300587,
"current_vault"=>nil,
"vault_token"=>nil,
"billing_address"=>"172 Abernathy Mountain",
"billing_city"=>"North Lornachester",
"billing_state"=>"CA",
"billing_zip"=>"63011-5354",
"billing_country"=>"US",
"customer_vault_token"=>nil,
"billing_address_2"=>"Suite 227",
"payment_type"=>"credit_card",
"disabled"=>false,
"site_gateway_setting_id"=>nil,
"gateway_handle"=>nil},
"prepaid_configuration"=>nil,
"group"=>nil,
"initial_billing_at"=>Sat, 01 Apr 2023 05:00:00 PDT -07:00},
"site"=>{"id"=>60050, "subdomain"=>"chargify-sandbox-141"},
"event_id"=>2950983304}
Back to list of Payload Examples
delayed_subscription_creation_success payload
{"subscription"=>
{"id"=>63126383,
"state"=>"awaiting_signup",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>nil,
"created_at"=>Fri, 10 Mar 2023 09:16:28 PST -08:00,
"updated_at"=>Fri, 10 Mar 2023 09:16:28 PST -08:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>Sat, 01 Apr 2023 05:00:00 PDT -07:00,
"next_assessment_at"=>Sat, 01 Apr 2023 05:00:00 PDT -07:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"next_product_handle"=>nil,
"cancel_at_end_of_period"=>nil,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Fri, 10 Mar 2023 09:16:28 PST -08:00,
"previous_state"=>"awaiting_signup",
"signup_payment_id"=>0,
"signup_revenue"=>"0.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>0,
"product_price_in_cents"=>10000,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"w376jg",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>nil,
"payer_id"=>64300481,
"receives_invoice_emails"=>nil,
"product_price_point_id"=>898846,
"next_product_price_point_id"=>nil,
"credit_balance_in_cents"=>0,
"prepayment_balance_in_cents"=>0,
"net_terms"=>nil,
"stored_credential_transaction_id"=>nil,
"locale"=>nil,
"reference"=>nil,
"currency"=>"USD",
"on_hold_at"=>nil,
"scheduled_cancellation_at"=>nil,
"prepaid_dunning"=>false,
"product_price_point_type"=>"default",
"dunning_communication_delay_enabled"=>false,
"dunning_communication_delay_time_zone"=>nil,
"customer"=>
{"id"=>64300481,
"first_name"=>"Leonie",
"last_name"=>"Hickle",
"organization"=>"McCullough, Bogisich and Bayer",
"email"=>"Cortney.Gulgowski59@example.com",
"created_at"=>Fri, 10 Mar 2023 09:15:24 PST -08:00,
"updated_at"=>Fri, 10 Mar 2023 09:15:24 PST -08:00,
"reference"=>nil,
"address"=>"064 Gislason Hollow",
"address_2"=>"Suite 099",
"city"=>"Lindberg",
"state"=>"NC",
"state_name"=>"North Carolina",
"zip"=>"39203-7738",
"country"=>"US",
"country_name"=>"United States",
"phone"=>"308-857-8585",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"vat_number"=>nil,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"product"=>
{"id"=>5209515,
"name"=>"Bronze Plan",
"handle"=>"bronze_plan",
"description"=>"my description",
"accounting_code"=>nil,
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>nil,
"created_at"=>Fri, 13 Mar 2020 14:32:26 PDT -07:00,
"updated_at"=>Fri, 13 Mar 2020 14:32:26 PDT -07:00,
"price_in_cents"=>10000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>nil,
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>nil,
"taxable"=>false,
"update_return_url"=>nil,
"tax_code"=>nil,
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>nil,
"default_product_price_point_id"=>898846,
"request_billing_address"=>false,
"require_billing_address"=>false,
"require_shipping_address"=>false,
"use_site_exchange_rate"=>true,
"item_category"=>nil,
"product_price_point_id"=>898846,
"product_price_point_name"=>"Original",
"product_price_point_handle"=>"uuid:0edd1580-47a0-0138-6907-060451d6a6ae",
"product_family"=>
{"id"=>1513518,
"name"=>"import test",
"description"=>"",
"handle"=>"import-test",
"accounting_code"=>nil,
"created_at"=>Wed, 11 Mar 2020 09:45:14 PDT -07:00,
"updated_at"=>Wed, 11 Mar 2020 09:45:14 PDT -07:00},
"public_signup_pages"=>[]},
"credit_card"=>
{"id"=>50327479,
"first_name"=>"Romaine",
"last_name"=>"Grimes",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>3,
"expiration_year"=>2024,
"customer_id"=>64300481,
"current_vault"=>"bogus",
"vault_token"=>"1",
"billing_address"=>"8193 Abner Greens",
"billing_city"=>"Westland",
"billing_state"=>"NM",
"billing_zip"=>"48592",
"billing_country"=>"US",
"customer_vault_token"=>nil,
"billing_address_2"=>"Suite 544",
"payment_type"=>"credit_card",
"disabled"=>false,
"site_gateway_setting_id"=>nil,
"gateway_handle"=>nil},
"prepaid_configuration"=>nil,
"group"=>nil,
"initial_billing_at"=>Sat, 01 Apr 2023 05:00:00 PDT -07:00,
"referred_by"=>nil},
"site"=>{"id"=>60050, "subdomain"=>"chargify-sandbox-141"},
"event_id"=>2950981186}
Back to list of Payload Examples
dunning_step_reached payload
"subscription" => {
"id" => 37,
"state" => "past_due",
"trial_started_at" => Wed, 25 Jan 2017 15:48:56 EST -05:00,
"trial_ended_at" => Wed, 25 Jan 2017 15:49:35 EST -05:00,
"activated_at" => nil,
"created_at" => Wed, 25 Jan 2017 15:48:56 EST -05:00,
"updated_at" => Wed, 25 Jan 2017 15:49:40 EST -05:00,
"expires_at" => nil,
"balance_in_cents" => 2400,
"current_period_ends_at" => Sat, 25 Feb 2017 15:49:35 EST -05:00,
"next_assessment_at" => Wed, 25 Jan 2017 15:49:35 EST -05:00,
"canceled_at" => nil,
"cancellation_message" => nil,
"next_product_id" => nil,
"cancel_at_end_of_period" => false,
"payment_collection_method" => "automatic",
"snap_day" => nil,
"cancellation_method" => nil,
"current_period_started_at" => Wed, 25 Jan 2017 15:49:35 EST -05:00,
"previous_state" => "past_due",
"signup_payment_id" => 101,
"signup_revenue" => "0.00",
"delayed_cancel_at" => nil,
"coupon_code" => nil,
"total_revenue_in_cents" => 0,
"product_price_in_cents" => 2400,
"product_version_number" => 1,
"payment_type" => nil,
"referral_code" => nil,
"coupon_use_count" => nil,
"coupon_uses_allowed" => nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"customer" => {
"id" => 37,
"first_name" => "Ella",
"last_name" => "Gertrude",
"organization" => "",
"email" => "ella@example.com",
"created_at" => Wed, 25 Jan 2017 15:48:56 EST -05:00,
"updated_at" => Wed, 25 Jan 2017 15:48:56 EST -05:00,
"reference" => nil,
"address" => "",
"address_2" => "",
"city" => "",
"state" => "",
"zip" => "",
"country" => "",
"phone" => "",
"portal_invite_last_sent_at" => nil,
"portal_invite_last_accepted_at" => nil,
"verified" => false,
"portal_customer_created_at" => nil,
"vat_number"=>"123456789"
"cc_emails" => nil,
"tax_exempt" => false,
"parent_id" => nil},
"product" => {
"id" => 24,
"name" => "Basic",
"handle" => "basic",
"description" => "Magni porro sint iste illum. Qui aut reiciendis voluptatum. Est et aut.",
"accounting_code" => nil,
"request_credit_card" => true,
"expiration_interval" => nil,
"expiration_interval_unit" => nil,
"created_at" => Mon, 23 Jan 2017 15:33:40 EST -05:00,
"updated_at" => Mon, 23 Jan 2017 15:33:40 EST -05:00,
"price_in_cents" => 2400,
"interval" => 1,
"interval_unit" => "month",
"initial_charge_in_cents" => nil,
"trial_price_in_cents" => 0,
"trial_interval" => 1,
"trial_interval_unit" => "month",
"archived_at" => nil,
"require_credit_card" => true,
"return_params" => nil,
"taxable" => false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial" => false,
"version_number" => 1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family" => {
"id" => 4,
"name" => "Acme Online",
"description" => nil,
"handle" => "acme-online",
"accounting_code" => nil},
"public_signup_pages" => [ {
"id" => 5,
"return_url" => nil,
"return_params" => nil,
"url" => "http://acme-test.chargify.dev/subscribe/y884dzrgd9r9/basic"}]}},
"dunner" => {
"subscription_id" => 37,
"state" => "active",
"attempts" => 1,
"last_attempted_at" => Wed, 25 Jan 2017 15:49:42 EST -05:00,
"created_at" => Wed, 25 Jan 2017 15:49:42 EST -05:00,
"revenue_at_risk_in_cents" => nil},
"current_step" => {
"day_threshold" => 1,
"action" => "retry",
"email_body" => "Hello ,\n\nWe just tried to process your current amount due of \nfor , but there is no credit card on file for this subscription. \n\nPlease use the following link to quickly and easily update your billing information:\n\n\nWe will attempt to retry the card on file prior to cancellation. If we are unable to successfully charge the outstanding balance of , your account will be canceled in 27 days.\n\nThank you for choosing us!\n\nSincerely,\n\n\n",
"email_subject" => "NOTICE: ",
"send_email" => true,
"send_bcc_email" => false,
"send_sms" => false,
"sms_body" => nil},
"next_step" => {
"day_threshold" => 28,
"action" => "cancel",
"email_body" => "Hello ,\n\n\nWe've made several attempts to bill you for your account but you have not yet provided us with a valid credit card profile.\n\nAs a result, your account has been canceled.\n\nIf you did not intend to cancel your account, please contact us to reactivate your account and avoid further interruption of your service.\n\nThank you for choosing us!\n\nSincerely,\n\n\n",
"email_subject" => "NOTICE: Account Canceled",
"send_email" => true,
"send_bcc_email" => false,
"send_sms" => false,
"sms_body" => nil},
"event_id" => 165}Back to list of Payload Examples
expiring_card payload
{"id"=>16474328,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Mon, 20 Feb 2017 18:28:48 EST -05:00,
"created_at"=>Mon, 20 Feb 2017 18:28:47 EST -05:00,
"updated_at"=>Mon, 20 Feb 2017 18:32:14 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>Mon, 20 Mar 2017 19:28:47 EDT -04:00,
"next_assessment_at"=>Mon, 20 Mar 2017 19:28:47 EDT -04:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 20 Feb 2017 18:28:47 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>174876340,
"signup_revenue"=>"0.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>0,
"product_price_in_cents"=>0,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"ww6mq5",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"customer"=>
{"id"=>15102905,
"first_name"=>"Amelia",
"last_name"=>"Example",
"organization"=>"",
"email"=>"amelia@example.com",
"created_at"=>Thu, 15 Dec 2016 09:33:15 EST -05:00,
"updated_at"=>Thu, 15 Dec 2016 09:34:09 EST -05:00,
"reference"=>nil,
"address"=>"",
"address_2"=>"",
"city"=>"",
"state"=>"",
"zip"=>"",
"country"=>"",
"phone"=>"",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>nil,
"portal_customer_created_at"=>Thu, 15 Dec 2016 09:33:21 EST -05:00,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false},
"product"=>
{"id"=>4461042,
"name"=>"Gold Product",
"handle"=>"gold-product",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Mon, 20 Feb 2017 18:28:18 EST -05:00,
"updated_at"=>Mon, 20 Feb 2017 18:28:18 EST -05:00,
"price_in_cents"=>0,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>312984,
"return_url"=>nil,
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/yt4ybcgk7998/zero-dollar-product"}]},
"credit_card"=>
{"id"=>10548239,
"first_name"=>"Amelia",
"last_name"=>"Example",
"masked_card_number"=>"XXXX-XXXX-XXXX-2",
"card_type"=>"bogus",
"expiration_month"=>2,
"expiration_year"=>2017,
"customer_id"=>15102905,
"current_vault"=>"bogus",
"vault_token"=>"2",
"billing_address"=>"",
"billing_city"=>"",
"billing_state"=>"",
"billing_zip"=>"",
"billing_country"=>"",
"customer_vault_token"=>nil,
"billing_address_2"=>"",
"payment_type"=>"credit_card"}},
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"event_id"=>380080310}Back to list of Payload Examples
expiration_date_change payload
"subscription"=>
{"id"=>16945349,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Fri, 03 Mar 2017 13:00:08 EST -05:00,
"created_at"=>Fri, 03 Mar 2017 13:00:02 EST -05:00,
"updated_at"=>Fri, 03 Mar 2017 13:03:55 EST -05:00,
"expires_at"=>Sun, 15 Oct 2017 00:00:00 EDT -04:00,
"balance_in_cents"=>0,
"current_period_ends_at"=>Sun, 05 Mar 2017 13:00:02 EST -05:00,
"next_assessment_at"=>Sat, 04 Mar 2017 13:00:02 EST -05:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Fri, 03 Mar 2017 13:00:02 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>176501894,
"signup_revenue"=>"1.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>100,
"product_price_in_cents"=>100,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"968js9",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"reason_code"=>nil,
"customer"=>
{"id"=>16428076,
"first_name"=>"Expiring ",
"last_name"=>"Subscription",
"organization"=>"",
"email"=>"expiring@example.com",
"created_at"=>Fri, 03 Mar 2017 13:00:02 EST -05:00,
"updated_at"=>Fri, 03 Mar 2017 13:00:02 EST -05:00,
"reference"=>nil,
"address"=>"",
"address_2"=>"",
"city"=>"",
"state"=>"",
"zip"=>"",
"country"=>"",
"phone"=>"",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>nil,
"portal_customer_created_at"=>nil,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil},
"product"=>
{"id"=>4464208,
"name"=>"Product that expires",
"handle"=>"product-that-expires",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>1,
"expiration_interval_unit"=>"day",
"created_at"=>Fri, 03 Mar 2017 12:02:38 EST -05:00,
"updated_at"=>Fri, 03 Mar 2017 12:02:38 EST -05:00,
"price_in_cents"=>100,
"interval"=>2,
"interval_unit"=>"day",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>314126,
"return_url"=>nil,
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/zs8352q9qtyz/product-that-expires"}]},
"credit_card"=>
{"id"=>11380641,
"first_name"=>"Expiring ",
"last_name"=>"Subscription",
"masked_card_number"=>"XXXX-XXXX-XXXX-1",
"card_type"=>"bogus",
"expiration_month"=>1,
"expiration_year"=>2027,
"customer_id"=>16428076,
"current_vault"=>"bogus",
"vault_token"=>"1",
"billing_address"=>"",
"billing_city"=>"",
"billing_state"=>"",
"billing_zip"=>"",
"billing_country"=>"",
"customer_vault_token"=>nil,
"billing_address_2"=>"",
"payment_type"=>"credit_card"},
"previous_expires_at"=>Wed, 15 Jul 2015 00:00:00 EDT -04:00},
"event_id"=>384446169}Back to list of Payload Examples
invoice_issued payload
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"subscription"=>
{"id"=>28224225,
"current_period_ends_at"=>Wed, 31 Jul 2019 15:25:54 CDT -05:00},
"invoice"=>
{"uid"=>"inv_4ffwqn13mppt7"
"role"=>"renewal",
"due_date"=>"2019-07-31",
"issue_date"=>"2019-07-31",
"paid_date"=>"",
"due_amount"=>"$3,000.00",
"paid_amount"=>"$0.00",
"refund_amount"=>"$0.00",
"tax_amount"=>"$0.00",
"total_amount"=>"$3,000.00",
"status_amount"=>"$3,000.00",
"product_name"=>"2000",
"line_items"=>
{"0"=>
{"uid"=>"li_8tjw5rjzyt287",
"title"=>"2000",
"description"=>"31 Jul 2019 - 31 Aug 2019",
"quantity"=>1,
"unit_price"=>"$3,000.00",
"period_range_start"=>"2019-07-31",
"period_range_end"=>"2019-08-31",
"amount"=>"$3,000.00",
"line_references"=>"",
"pricing_details_index"=>nil,
"pricing_details"=>{},
"tax_code"=>nil,
"tax_amount"=>"0.0"}}},
"event_id"=>854499834}Back to list of Payload Examples
metered_usage payload
"component"=>
{"id"=>375042,
"kind"=>"metered_component",
"name"=>"Test Metered",
"unit_name"=>"Test Metered"},
"subscription"=>{"id"=>16372192, "name"=>"Doris Tester"},
"product"=>{"id"=>4443536, "name"=>"Business Monthly"},
"memo"=>"Recording Metered Component Usage",
"timestamp"=>"2017-02-13T18:50:23Z",
"previous_unit_balance"=>#<BigDecimal:7f097c4b7d28,'0.0',9(18)>,
"new_unit_balance"=>1000,
"usage_quantity"=>1000,
"event_id"=>377609676}Back to list of Payload Examples
payment_failure payload
"subscription"=>
{"id"=>16090357,
"state"=>"past_due",
"trial_started_at"=>Mon, 23 Jan 2017 09:59:26 EST -05:00,
"trial_ended_at"=>Mon, 23 Jan 2017 09:59:49 EST -05:00,
"activated_at"=>nil,
"created_at"=>Mon, 23 Jan 2017 09:59:26 EST -05:00,
"updated_at"=>Mon, 30 Jan 2017 12:07:40 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>1000,
"current_period_ends_at"=>Thu, 23 Feb 2017 09:59:49 EST -05:00,
"next_assessment_at"=>Tue, 31 Jan 2017 12:07:40 EST -05:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 23 Jan 2017 09:59:49 EST -05:00,
"previous_state"=>"past_due",
"signup_payment_id"=>171203419,
"signup_revenue"=>"0.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>0,
"product_price_in_cents"=>1000,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"4nvrr2",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"currency"=>"USD",
"customer"=>
{"id"=>15547334,
"first_name"=>"No obligation",
"last_name"=>"Bad Card",
"organization"=>"",
"email"=>"nobbad@example.com",
"created_at"=>Mon, 23 Jan 2017 09:59:26 EST -05:00,
"updated_at"=>Mon, 23 Jan 2017 09:59:28 EST -05:00,
"reference"=>nil,
"address"=>"",
"address_2"=>"",
"city"=>"",
"state"=>"",
"zip"=>"",
"country"=>"",
"phone"=>"",
"portal_invite_last_sent_at"=>Mon, 23 Jan 2017 09:59:28 EST -05:00,
"portal_invite_last_accepted_at"=>nil,
"verified"=>nil,
"portal_customer_created_at"=>Mon, 23 Jan 2017 09:59:28 EST -05:00,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil},
"product"=>
{"id"=>4453830,
"name"=>"Trial No obligation",
"handle"=>"trial-no-obligation",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Mon, 23 Jan 2017 09:53:23 EST -05:00,
"updated_at"=>Thu, 26 Jan 2017 13:35:29 EST -05:00,
"price_in_cents"=>1000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>0,
"trial_interval"=>1,
"trial_interval_unit"=>"day",
"archived_at"=>nil,
"require_credit_card"=>false,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>310559,
"return_url"=>nil,
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/ngbsvxv4hq7q/trial-no-obligation"}]},
"credit_card"=>
{"id"=>10734525,
"first_name"=>"Chester",
"last_name"=>"Tester",
"masked_card_number"=>"XXXX-XXXX-XXXX-2",
"card_type"=>"bogus",
"expiration_month"=>1,
"expiration_year"=>2027,
"customer_id"=>15547334,
"current_vault"=>"bogus",
"vault_token"=>"2",
"billing_address"=>"",
"billing_city"=>"",
"billing_state"=>"",
"billing_zip"=>"",
"billing_country"=>"",
"customer_vault_token"=>nil,
"billing_address_2"=>"",
"payment_type"=>"credit_card"}},
"transaction"=>
{"id"=>172084191,
"subscription_id"=>16090357,
"type"=>"Payment",
"kind"=>nil,
"transaction_type"=>"payment",
"success"=>false,
"amount_in_cents"=>1000,
"memo"=>"Bogus Gateway: Forced failure",
"created_at"=>Mon, 30 Jan 2017 12:07:39 EST -05:00,
"starting_balance_in_cents"=>1000,
"ending_balance_in_cents"=>1000,
"gateway_used"=>"bogus",
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>4453830,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>84491989,
"customer_id"=>15547334,
"card_number"=>"XXXX-XXXX-XXXX-2",
"card_expiration"=>"01/2027",
"card_type"=>"bogus",
"refunded_amount_in_cents"=>0,
"invoice_uids"=>["inv_9hchn3xc84mgm"],
"invoice_id"=>nil,
"currency"=>"USD"},
"event_id"=>372846073}Back to list of Payload Examples
payment_success payload
"subscription"=>
{"id"=>16327080,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Thu, 09 Feb 2017 11:42:28 EST -05:00,
"created_at"=>Thu, 09 Feb 2017 11:42:26 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 12:03:41 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>Wed, 08 Mar 2017 12:00:00 EST -05:00,
"next_assessment_at"=>Wed, 08 Mar 2017 12:00:00 EST -05:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>"8",
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 13 Feb 2017 12:00:00 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>0,
"signup_revenue"=>"0.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>5667,
"product_price_in_cents"=>6900,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"6zcsxw",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"payer_id"=>15780191,
"currency"=>"USD",
"customer"=>
{"id"=>15780191,
"first_name"=>"Test "
"last_name"=>"Test",
"organization"=>"",
"email"=>"test@example.com",
"created_at"=>Thu, 09 Feb 2017 11:42:26 EST -05:00,
"updated_at"=>Thu, 09 Feb 2017 11:42:29 EST -05:00,
"reference"=>nil,
"address"=>nil,
"address_2"=>nil,
"city"=>nil,
"state"=>nil,
"zip"=>nil,
"country"=>nil,
"phone"=>"",
"portal_invite_last_sent_at"=>Thu, 09 Feb 2017 11:42:29 EST -05:00,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>Thu, 09 Feb 2017 11:42:29 EST -05:00,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil},
"product"=>
{"id"=>4458204,
"name"=>"Monthly product ",
"handle"=>"monthly-product",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Wed, 08 Feb 2017 16:48:54 EST -05:00,
"updated_at"=>Wed, 08 Feb 2017 16:48:54 EST -05:00,
"price_in_cents"=>6900,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>312067,
"return_url"=>nil,
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/5x8sbq29vgkn/monthly-product"},
{"id"=>312068,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/vsmzkwvmfqqx/monthly-product"}]},
"credit_card"=>
{"id"=>10881632,
"first_name"=>"Test",
"last_name"=>"Page",
"masked_card_number"=>"XXXX-XXXX-XXXX-1",
"card_type"=>"bogus",
"expiration_month"=>1,
"expiration_year"=>2027,
"customer_id"=>15780191,
"current_vault"=>"bogus",
"vault_token"=>"1",
"billing_address"=>nil,
"billing_city"=>nil,
"billing_state"=>nil,
"billing_zip"=>"",
"billing_country"=>nil,
"customer_vault_token"=>nil,
"billing_address_2"=>nil,
"payment_type"=>"credit_card"}},
"transaction"=>
{"id"=>173963435,
"subscription_id"=>16327080,
"type"=>"Payment",
"kind"=>nil,
"transaction_type"=>"payment",
"success"=>true,
"amount_in_cents"=>5667,
"memo"=>"Test Monthly - Monthly product : Renewal payment",
"created_at"=>Mon, 13 Feb 2017 12:03:40 EST -05:00,
"starting_balance_in_cents"=>5667,
"ending_balance_in_cents"=>0,
"gateway_used"=>"bogus",
"gateway_transaction_id"=>"53433",
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>4458204,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>85701746,
"customer_id"=>15780191,
"card_number"=>"XXXX-XXXX-XXXX-1",
"card_expiration"=>"01/2027",
"card_type"=>"bogus",
"refunded_amount_in_cents"=>0,
"invoice_uids"=>["inv_9hchn3xc84mgm"],
"invoice_id"=>nil,
"currency"=>"USD"},
"event_id"=>377575306}Back to list of Payload Examples
direct_debit_payment_pending payload
"subscription"=>
{"id"=>102485,
"state"=>"pending",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>nil,
"created_at"=>Thu, 25 Feb 2021 03:32:54 EST -05:00,
"updated_at"=>Thu, 25 Feb 2021 03:33:00 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>nil,
"next_assessment_at"=>nil,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"next_product_handle"=>nil,
"cancel_at_end_of_period"=>nil,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Thu, 25 Feb 2021 03:32:54 EST -05:00,
"previous_state"=>"pending",
"signup_payment_id"=>34793,
"signup_revenue"=>"30,00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>3000,
"product_price_in_cents"=>3000,
"product_version_number"=>1,
"payment_type"=>"bank_account",
"referral_code"=>nil,
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>nil,
"payer_id"=>nil,
"receives_invoice_emails"=>nil,
"product_price_point_id"=>466,
"next_product_price_point_id"=>nil,
"credit_balance_in_cents"=>0,
"prepayment_balance_in_cents"=>0,
"net_terms"=>nil,
"stored_credential_transaction_id"=>nil,
"locale"=>nil,
"reference"=>nil,
"currency"=>"EUR",
"on_hold_at"=>nil,
"scheduled_cancellation_at"=>nil,
"customer"=>
{"id"=>4260,
"first_name"=>"Test",
"last_name"=>"Test",
"organization"=>"",
"email"=>"test@example.com",
"created_at"=>Thu, 25 Feb 2021 03:32:53 EST -05:00,
"updated_at"=>Thu, 25 Feb 2021 03:32:53 EST -05:00,
"reference"=>nil,
"address"=>nil,
"address_2"=>nil,
"city"=>nil,
"state"=>nil,
"state_name"=>nil,
"zip"=>nil,
"country"=>nil,
"country_name"=>nil,
"phone"=>"",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"vat_number"=>nil,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"product"=>
{"id"=>372,
"name"=>"test",
"handle"=>"test",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Wed, 09 Dec 2020 05:06:07 EST -05:00,
"updated_at"=>Thu, 21 Jan 2021 09:28:12 EST -05:00,
"price_in_cents"=>3000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"",
"tax_code"=>"",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"",
"default_product_price_point_id"=>466,
"request_billing_address"=>false,
"require_billing_address"=>false,
"require_shipping_address"=>false,
"product_price_point_id"=>466,
"product_price_point_name"=>"Original",
"product_price_point_handle"=>"uuid:14078c50-1c34-0139-f2b7-08e9fe639598",
"product_family"=>
{"id"=>131,
"name"=>"Billing Plans",
"description"=>nil,
"handle"=>"test-billing-plans",
"accounting_code"=>nil,
"created_at"=>Wed, 09 Dec 2020 04:37:03 EST -05:00,
"updated_at"=>Wed, 09 Dec 2020 04:37:03 EST -05:00},
"public_signup_pages"=>
[{"id"=>199,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://test-71.chargifypay.test/subscribe/3gx9xh5z8gj2/test"}]},
"bank_account"=>
{"id"=>5847,
"first_name"=>"Test",
"last_name"=>"Test",
"customer_id"=>4260,
"current_vault"=>"stripe_connect",
"vault_token"=>"cus_J0gewnaw35SKLd",
"billing_address"=>nil,
"billing_city"=>nil,
"billing_state"=>nil,
"billing_zip"=>nil,
"billing_country"=>nil,
"customer_vault_token"=>nil,
"billing_address_2"=>nil,
"bank_name"=>nil,
"masked_bank_routing_number"=>nil,
"masked_bank_account_number"=>"XXXX3000",
"bank_account_type"=>"checking",
"bank_account_holder_type"=>"personal",
"payment_type"=>"bank_account",
"verified"=>true,
"site_gateway_setting_id"=>402},
"group"=>nil},
"transaction"=>
{"id"=>34793,
"subscription_id"=>102485,
"type"=>"Payment",
"kind"=>nil,
"transaction_type"=>"payment",
"success"=>true,
"amount_in_cents"=>3000,
"memo"=>"Test Test - test: Signup payment",
"created_at"=>Thu, 25 Feb 2021 03:33:00 EST -05:00,
"starting_balance_in_cents"=>3000,
"ending_balance_in_cents"=>0,
"gateway_used"=>"stripe_connect",
"gateway_transaction_id"=>"pi_1IOfHLKajOcZzbwkfsXCKj1P",
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>372,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>24750,
"customer_id"=>4260,
"item_name"=>nil,
"period_range_start"=>nil,
"period_range_end"=>nil,
"currency"=>"EUR",
"exchange_rate"=>1,
"component_handle"=>nil,
"component_price_point_id"=>nil,
"component_price_point_handle"=>nil,
"parent_id"=>nil,
"role"=>nil,
"card_number"=>nil,
"card_expiration"=>nil,
"card_type"=>nil,
"refunded_amount_in_cents"=>0,
"invoice_id"=>nil},
"event_id"=>51595}Back to list of Payload Examples
direct_debit_payment_paid_out payload
"subscription"=>
{"id"=>102485,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Thu, 25 Feb 2021 03:33:01 EST -05:00,
"created_at"=>Thu, 25 Feb 2021 03:32:54 EST -05:00,
"updated_at"=>Thu, 25 Feb 2021 03:33:10 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>Thu, 25 Mar 2021 04:32:54 EDT -04:00,
"next_assessment_at"=>Thu, 25 Mar 2021 04:32:54 EDT -04:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"next_product_handle"=>nil,
"cancel_at_end_of_period"=>nil,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Thu, 25 Feb 2021 03:32:54 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>34793,
"signup_revenue"=>"30,00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>3000,
"product_price_in_cents"=>3000,
"product_version_number"=>1,
"payment_type"=>"bank_account",
"referral_code"=>nil,
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>nil,
"payer_id"=>nil,
"receives_invoice_emails"=>nil,
"product_price_point_id"=>466,
"next_product_price_point_id"=>nil,
"credit_balance_in_cents"=>0,
"prepayment_balance_in_cents"=>0,
"net_terms"=>nil,
"stored_credential_transaction_id"=>nil,
"locale"=>nil,
"reference"=>nil,
"currency"=>"EUR",
"on_hold_at"=>nil,
"scheduled_cancellation_at"=>nil,
"customer"=>
{"id"=>4260,
"first_name"=>"Test",
"last_name"=>"Test",
"organization"=>"",
"email"=>"test@example.com",
"created_at"=>Thu, 25 Feb 2021 03:32:53 EST -05:00,
"updated_at"=>Thu, 25 Feb 2021 03:32:53 EST -05:00,
"reference"=>nil,
"address"=>nil,
"address_2"=>nil,
"city"=>nil,
"state"=>nil,
"state_name"=>nil,
"zip"=>nil,
"country"=>nil,
"country_name"=>nil,
"phone"=>"",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"vat_number"=>nil,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"product"=>
{"id"=>372,
"name"=>"test",
"handle"=>"test",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Wed, 09 Dec 2020 05:06:07 EST -05:00,
"updated_at"=>Thu, 21 Jan 2021 09:28:12 EST -05:00,
"price_in_cents"=>3000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"",
"tax_code"=>"",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"",
"default_product_price_point_id"=>466,
"request_billing_address"=>false,
"require_billing_address"=>false,
"require_shipping_address"=>false,
"product_price_point_id"=>466,
"product_price_point_name"=>"Original",
"product_price_point_handle"=>"uuid:14078c50-1c34-0139-f2b7-08e9fe639598",
"product_family"=>
{"id"=>131,
"name"=>"Billing Plans",
"description"=>nil,
"handle"=>"test-billing-plans",
"accounting_code"=>nil,
"created_at"=>Wed, 09 Dec 2020 04:37:03 EST -05:00,
"updated_at"=>Wed, 09 Dec 2020 04:37:03 EST -05:00},
"public_signup_pages"=>
[{"id"=>199,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://test-71.chargifypay.test/subscribe/3gx9xh5z8gj2/test"}]},
"bank_account"=>
{"id"=>5847,
"first_name"=>"Test",
"last_name"=>"Test",
"customer_id"=>4260,
"current_vault"=>"stripe_connect",
"vault_token"=>"cus_J0gewnaw35SKLd",
"billing_address"=>nil,
"billing_city"=>nil,
"billing_state"=>nil,
"billing_zip"=>nil,
"billing_country"=>nil,
"customer_vault_token"=>nil,
"billing_address_2"=>nil,
"bank_name"=>nil,
"masked_bank_routing_number"=>nil,
"masked_bank_account_number"=>"XXXX3000",
"bank_account_type"=>"checking",
"bank_account_holder_type"=>"personal",
"payment_type"=>"bank_account",
"verified"=>true,
"site_gateway_setting_id"=>402},
"group"=>nil},
"transaction"=>
{"id"=>34793,
"subscription_id"=>102485,
"type"=>"Payment",
"kind"=>nil,
"transaction_type"=>"payment",
"success"=>true,
"amount_in_cents"=>3000,
"memo"=>"Test Test - test: Signup payment",
"created_at"=>Thu, 25 Feb 2021 03:33:00 EST -05:00,
"starting_balance_in_cents"=>3000,
"ending_balance_in_cents"=>0,
"gateway_used"=>"stripe_connect",
"gateway_transaction_id"=>"pi_1IOfHLKajOcZzbwkfsXCKj1P",
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>372,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>24750,
"customer_id"=>4260,
"item_name"=>nil,
"period_range_start"=>nil,
"period_range_end"=>nil,
"currency"=>"EUR",
"exchange_rate"=>1,
"component_handle"=>nil,
"component_price_point_id"=>nil,
"component_price_point_handle"=>nil,
"parent_id"=>nil,
"role"=>nil,
"card_number"=>nil,
"card_expiration"=>nil,
"card_type"=>nil,
"refunded_amount_in_cents"=>0,
"invoice_id"=>nil},
"event_id"=>51601}Back to list of Payload Examples
direct_debit_payment_rejected payload
"subscription"=>
{"id"=>102493,
"state"=>"past_due",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Thu, 25 Feb 2021 05:27:47 EST -05:00,
"created_at"=>Thu, 25 Feb 2021 05:27:38 EST -05:00,
"updated_at"=>Thu, 25 Feb 2021 05:28:06 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>3000,
"current_period_ends_at"=>Thu, 25 Mar 2021 06:27:38 EDT -04:00,
"next_assessment_at"=>Fri, 26 Feb 2021 05:28:06 EST -05:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"next_product_handle"=>nil,
"cancel_at_end_of_period"=>nil,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Thu, 25 Feb 2021 05:27:38 EST -05:00,
"previous_state"=>"past_due",
"signup_payment_id"=>34807,
"signup_revenue"=>"30,00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>0,
"product_price_in_cents"=>3000,
"product_version_number"=>1,
"payment_type"=>"bank_account",
"referral_code"=>nil,
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>nil,
"payer_id"=>nil,
"receives_invoice_emails"=>nil,
"product_price_point_id"=>466,
"next_product_price_point_id"=>nil,
"credit_balance_in_cents"=>0,
"prepayment_balance_in_cents"=>0,
"net_terms"=>nil,
"stored_credential_transaction_id"=>nil,
"locale"=>nil,
"reference"=>nil,
"currency"=>"EUR",
"on_hold_at"=>nil,
"scheduled_cancellation_at"=>nil,
"customer"=>
{"id"=>4268,
"first_name"=>"Test",
"last_name"=>"Test",
"organization"=>"",
"email"=>"test@example.com",
"created_at"=>Thu, 25 Feb 2021 05:27:38 EST -05:00,
"updated_at"=>Thu, 25 Feb 2021 05:27:38 EST -05:00,
"reference"=>nil,
"address"=>nil,
"address_2"=>nil,
"city"=>nil,
"state"=>nil,
"state_name"=>nil,
"zip"=>nil,
"country"=>nil,
"country_name"=>nil,
"phone"=>"",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"vat_number"=>nil,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"product"=>
{"id"=>372,
"name"=>"test",
"handle"=>"test",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Wed, 09 Dec 2020 05:06:07 EST -05:00,
"updated_at"=>Thu, 21 Jan 2021 09:28:12 EST -05:00,
"price_in_cents"=>3000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"",
"tax_code"=>"",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"",
"default_product_price_point_id"=>466,
"request_billing_address"=>false,
"require_billing_address"=>false,
"require_shipping_address"=>false,
"product_price_point_id"=>466,
"product_price_point_name"=>"Original",
"product_price_point_handle"=>"uuid:14078c50-1c34-0139-f2b7-08e9fe639598",
"product_family"=>
{"id"=>131,
"name"=>"Billing Plans",
"description"=>nil,
"handle"=>"test-billing-plans",
"accounting_code"=>nil,
"created_at"=>Wed, 09 Dec 2020 04:37:03 EST -05:00,
"updated_at"=>Wed, 09 Dec 2020 04:37:03 EST -05:00},
"public_signup_pages"=>
[{"id"=>199,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://test-71.chargifypay.test/subscribe/3gx9xh5z8gj2/test"}]},
"bank_account"=>
{"id"=>5855,
"first_name"=>"Test",
"last_name"=>"Test",
"customer_id"=>4268,
"current_vault"=>"stripe_connect",
"vault_token"=>"cus_J0iV6HHEeYiAX4",
"billing_address"=>nil,
"billing_city"=>nil,
"billing_state"=>nil,
"billing_zip"=>nil,
"billing_country"=>nil,
"customer_vault_token"=>nil,
"billing_address_2"=>nil,
"bank_name"=>nil,
"masked_bank_routing_number"=>nil,
"masked_bank_account_number"=>"XXXX3001",
"bank_account_type"=>"checking",
"bank_account_holder_type"=>"personal",
"payment_type"=>"bank_account",
"verified"=>true,
"site_gateway_setting_id"=>402},
"group"=>nil},
"transaction"=>
{"id"=>34807,
"subscription_id"=>102493,
"type"=>"Payment",
"kind"=>nil,
"transaction_type"=>"payment",
"success"=>false,
"amount_in_cents"=>3000,
"memo"=>"Test Test - test: Signup payment",
"created_at"=>Thu, 25 Feb 2021 05:27:45 EST -05:00,
"starting_balance_in_cents"=>3000,
"ending_balance_in_cents"=>0,
"gateway_used"=>"stripe_connect",
"gateway_transaction_id"=>"pi_1IOh4NKajOcZzbwkC2xrThzC",
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>372,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>24757,
"customer_id"=>4268,
"item_name"=>nil,
"period_range_start"=>nil,
"period_range_end"=>nil,
"currency"=>"EUR",
"exchange_rate"=>1,
"component_handle"=>nil,
"component_price_point_id"=>nil,
"component_price_point_handle"=>nil,
"parent_id"=>nil,
"role"=>nil,
"card_number"=>nil,
"card_expiration"=>nil,
"card_type"=>nil,
"refunded_amount_in_cents"=>0,
"invoice_id"=>nil},
"event_id"=>51655}Back to list of Payload Examples
pending_payment_created payload
"subscription"=>
{"id"=>784,
"state"=>"pending",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>nil,
"created_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"updated_at"=>Wed, 18 Aug 2021 05:58:43 EDT -04:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>nil,
"next_assessment_at"=>nil,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"next_product_handle"=>nil,
"cancel_at_end_of_period"=>nil,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"previous_state"=>"pending",
"signup_payment_id"=>3556,
"signup_revenue"=>"500.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>50000,
"product_price_in_cents"=>50000,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>nil,
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>nil,
"payer_id"=>nil,
"receives_invoice_emails"=>nil,
"product_price_point_id"=>168,
"next_product_price_point_id"=>nil,
"credit_balance_in_cents"=>0,
"prepayment_balance_in_cents"=>0,
"net_terms"=>nil,
"stored_credential_transaction_id"=>nil,
"locale"=>nil,
"reference"=>nil,
"currency"=>"USD",
"on_hold_at"=>nil,
"scheduled_cancellation_at"=>nil,
"customer"=>
{"id"=>708,
"first_name"=>"John",
"last_name"=>"Doe",
"organization"=>"",
"email"=>"test@example.com",
"created_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"updated_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"reference"=>nil,
"address"=>"Street",
"address_2"=>"",
"city"=>"San Francisco",
"state"=>"CA",
"state_name"=>"California",
"zip"=>"66785",
"country"=>"US",
"country_name"=>"United States",
"phone"=>"123456789",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"vat_number"=>nil,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"product"=>
{"id"=>154,
"name"=>"golder",
"handle"=>"golderrr",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Mon, 05 Jul 2021 08:32:52 EDT -04:00,
"updated_at"=>Tue, 20 Jul 2021 08:08:49 EDT -04:00,
"price_in_cents"=>50000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>true,
"update_return_url"=>"",
"tax_code"=>"4512.100",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"",
"default_product_price_point_id"=>168,
"request_billing_address"=>true,
"require_billing_address"=>true,
"require_shipping_address"=>true,
"product_price_point_id"=>168,
"product_price_point_name"=>"Original",
"product_price_point_handle"=>"uuid:0a6d2640-bfbb-0139-c94b-2cde48001122",
"product_family"=>
{"id"=>65,
"name"=>"Billing Plans",
"description"=>nil,
"handle"=>"chargify-billing-plans",
"accounting_code"=>nil,
"created_at"=>Mon, 21 Jun 2021 08:22:16 EDT -04:00,
"updated_at"=>Mon, 21 Jun 2021 08:22:16 EDT -04:00},
"public_signup_pages"=>
[{"id"=>101,
"return_url"=>nil,
"return_params"=>"",
"url"=>
"https://some-subdomain.chargifypay.test/subscribe/nmxwp8gsjh3t/golderrr"}]},
"credit_card"=>
{"id"=>885,
"first_name"=>"John",
"last_name"=>"Doe",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>1,
"expiration_year"=>2029,
"customer_id"=>708,
"current_vault"=>"digital_river",
"vault_token"=>"b0aeda54-7576-4457-a36b-e775d2730df8",
"billing_address"=>"Street",
"billing_city"=>"San Francisco",
"billing_state"=>"CA",
"billing_zip"=>"66785",
"billing_country"=>"US",
"customer_vault_token"=>"541159940336",
"billing_address_2"=>"",
"payment_type"=>"credit_card",
"disabled"=>false,
"site_gateway_setting_id"=>71},
"group"=>nil},
"transaction"=>
{"id"=>3556,
"subscription_id"=>784,
"type"=>"Payment",
"kind"=>nil,
"transaction_type"=>"payment",
"success"=>true,
"amount_in_cents"=>50000,
"memo"=>"John Doe - golder: Signup payment",
"created_at"=>Wed, 18 Aug 2021 05:58:43 EDT -04:00,
"starting_balance_in_cents"=>50000,
"ending_balance_in_cents"=>0,
"gateway_used"=>"digital_river",
"gateway_transaction_id"=>"3daa894a-77e5-4bd9-88b9-8e6dd1e84185",
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>154,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>1553,
"customer_id"=>708,
"item_name"=>nil,
"period_range_start"=>nil,
"period_range_end"=>nil,
"currency"=>"USD",
"exchange_rate"=>1,
"component_handle"=>nil,
"component_price_point_id"=>nil,
"component_price_point_handle"=>nil,
"parent_id"=>nil,
"role"=>nil,
"card_number"=>"XXXX-XXXX-XXXX-1111",
"card_expiration"=>"01/2029",
"card_type"=>"visa",
"refunded_amount_in_cents"=>0,
"invoice_id"=>nil},
"event_id"=>5432}Back to list of Payload Examples
pending_payment_completed payload
"subscription"=>
{"id"=>784,
"state"=>"pending",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>nil,
"created_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"updated_at"=>Wed, 18 Aug 2021 05:58:43 EDT -04:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>nil,
"next_assessment_at"=>nil,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"next_product_handle"=>nil,
"cancel_at_end_of_period"=>nil,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"previous_state"=>"pending",
"signup_payment_id"=>3556,
"signup_revenue"=>"500.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>50000,
"product_price_in_cents"=>50000,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>nil,
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>nil,
"payer_id"=>nil,
"receives_invoice_emails"=>nil,
"product_price_point_id"=>168,
"next_product_price_point_id"=>nil,
"credit_balance_in_cents"=>0,
"prepayment_balance_in_cents"=>0,
"net_terms"=>nil,
"stored_credential_transaction_id"=>nil,
"locale"=>nil,
"reference"=>nil,
"currency"=>"USD",
"on_hold_at"=>nil,
"scheduled_cancellation_at"=>nil,
"customer"=>
{"id"=>708,
"first_name"=>"John",
"last_name"=>"Doe",
"organization"=>"",
"email"=>"test@example.com",
"created_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"updated_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"reference"=>nil,
"address"=>"Street",
"address_2"=>"",
"city"=>"San Francisco",
"state"=>"CA",
"state_name"=>"California",
"zip"=>"66785",
"country"=>"US",
"country_name"=>"United States",
"phone"=>"123456789",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"vat_number"=>nil,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"product"=>
{"id"=>154,
"name"=>"golder",
"handle"=>"golderrr",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Mon, 05 Jul 2021 08:32:52 EDT -04:00,
"updated_at"=>Tue, 20 Jul 2021 08:08:49 EDT -04:00,
"price_in_cents"=>50000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>true,
"update_return_url"=>"",
"tax_code"=>"4512.100",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"",
"default_product_price_point_id"=>168,
"request_billing_address"=>true,
"require_billing_address"=>true,
"require_shipping_address"=>true,
"product_price_point_id"=>168,
"product_price_point_name"=>"Original",
"product_price_point_handle"=>"uuid:0a6d2640-bfbb-0139-c94b-2cde48001122",
"product_family"=>
{"id"=>65,
"name"=>"Billing Plans",
"description"=>nil,
"handle"=>"chargify-billing-plans",
"accounting_code"=>nil,
"created_at"=>Mon, 21 Jun 2021 08:22:16 EDT -04:00,
"updated_at"=>Mon, 21 Jun 2021 08:22:16 EDT -04:00},
"public_signup_pages"=>
[{"id"=>101,
"return_url"=>nil,
"return_params"=>"",
"url"=>
"https://some-subdomain.chargifypay.test/subscribe/nmxwp8gsjh3t/golderrr"}]},
"credit_card"=>
{"id"=>885,
"first_name"=>"John",
"last_name"=>"Doe",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>1,
"expiration_year"=>2029,
"customer_id"=>708,
"current_vault"=>"digital_river",
"vault_token"=>"b0aeda54-7576-4457-a36b-e775d2730df8",
"billing_address"=>"Street",
"billing_city"=>"San Francisco",
"billing_state"=>"CA",
"billing_zip"=>"66785",
"billing_country"=>"US",
"customer_vault_token"=>"541159940336",
"billing_address_2"=>"",
"payment_type"=>"credit_card",
"disabled"=>false,
"site_gateway_setting_id"=>71},
"group"=>nil},
"transaction"=>
{"id"=>3556,
"subscription_id"=>784,
"type"=>"Payment",
"kind"=>nil,
"transaction_type"=>"payment",
"success"=>true,
"amount_in_cents"=>50000,
"memo"=>"John Doe - golder: Signup payment",
"created_at"=>Wed, 18 Aug 2021 05:58:43 EDT -04:00,
"starting_balance_in_cents"=>50000,
"ending_balance_in_cents"=>0,
"gateway_used"=>"digital_river",
"gateway_transaction_id"=>"3daa894a-77e5-4bd9-88b9-8e6dd1e84185",
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>154,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>1553,
"customer_id"=>708,
"item_name"=>nil,
"period_range_start"=>nil,
"period_range_end"=>nil,
"currency"=>"USD",
"exchange_rate"=>1,
"component_handle"=>nil,
"component_price_point_id"=>nil,
"component_price_point_handle"=>nil,
"parent_id"=>nil,
"role"=>nil,
"card_number"=>"XXXX-XXXX-XXXX-1111",
"card_expiration"=>"01/2029",
"card_type"=>"visa",
"refunded_amount_in_cents"=>0,
"invoice_id"=>nil},
"event_id"=>5432}Back to list of Payload Examples
pending_payment_failed payload
"subscription"=>
{"id"=>784,
"state"=>"pending",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>nil,
"created_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"updated_at"=>Wed, 18 Aug 2021 05:58:43 EDT -04:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>nil,
"next_assessment_at"=>nil,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"next_product_handle"=>nil,
"cancel_at_end_of_period"=>nil,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"previous_state"=>"pending",
"signup_payment_id"=>3556,
"signup_revenue"=>"500.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>50000,
"product_price_in_cents"=>50000,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>nil,
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>nil,
"payer_id"=>nil,
"receives_invoice_emails"=>nil,
"product_price_point_id"=>168,
"next_product_price_point_id"=>nil,
"credit_balance_in_cents"=>0,
"prepayment_balance_in_cents"=>0,
"net_terms"=>nil,
"stored_credential_transaction_id"=>nil,
"locale"=>nil,
"reference"=>nil,
"currency"=>"USD",
"on_hold_at"=>nil,
"scheduled_cancellation_at"=>nil,
"customer"=>
{"id"=>708,
"first_name"=>"John",
"last_name"=>"Doe",
"organization"=>"",
"email"=>"test@example.com",
"created_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"updated_at"=>Wed, 18 Aug 2021 05:58:29 EDT -04:00,
"reference"=>nil,
"address"=>"Street",
"address_2"=>"",
"city"=>"San Francisco",
"state"=>"CA",
"state_name"=>"California",
"zip"=>"66785",
"country"=>"US",
"country_name"=>"United States",
"phone"=>"123456789",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"vat_number"=>nil,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"product"=>
{"id"=>154,
"name"=>"golder",
"handle"=>"golderrr",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Mon, 05 Jul 2021 08:32:52 EDT -04:00,
"updated_at"=>Tue, 20 Jul 2021 08:08:49 EDT -04:00,
"price_in_cents"=>50000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>true,
"update_return_url"=>"",
"tax_code"=>"4512.100",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"",
"default_product_price_point_id"=>168,
"request_billing_address"=>true,
"require_billing_address"=>true,
"require_shipping_address"=>true,
"product_price_point_id"=>168,
"product_price_point_name"=>"Original",
"product_price_point_handle"=>"uuid:0a6d2640-bfbb-0139-c94b-2cde48001122",
"product_family"=>
{"id"=>65,
"name"=>"Billing Plans",
"description"=>nil,
"handle"=>"chargify-billing-plans",
"accounting_code"=>nil,
"created_at"=>Mon, 21 Jun 2021 08:22:16 EDT -04:00,
"updated_at"=>Mon, 21 Jun 2021 08:22:16 EDT -04:00},
"public_signup_pages"=>
[{"id"=>101,
"return_url"=>nil,
"return_params"=>"",
"url"=>
"https://some-subdomain.chargifypay.test/subscribe/nmxwp8gsjh3t/golderrr"}]},
"credit_card"=>
{"id"=>885,
"first_name"=>"John",
"last_name"=>"Doe",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>1,
"expiration_year"=>2029,
"customer_id"=>708,
"current_vault"=>"digital_river",
"vault_token"=>"b0aeda54-7576-4457-a36b-e775d2730df8",
"billing_address"=>"Street",
"billing_city"=>"San Francisco",
"billing_state"=>"CA",
"billing_zip"=>"66785",
"billing_country"=>"US",
"customer_vault_token"=>"541159940336",
"billing_address_2"=>"",
"payment_type"=>"credit_card",
"disabled"=>false,
"site_gateway_setting_id"=>71},
"group"=>nil},
"transaction"=>
{"id"=>3556,
"subscription_id"=>784,
"type"=>"Payment",
"kind"=>nil,
"transaction_type"=>"payment",
"success"=>true,
"amount_in_cents"=>50000,
"memo"=>"John Doe - golder: Signup payment",
"created_at"=>Wed, 18 Aug 2021 05:58:43 EDT -04:00,
"starting_balance_in_cents"=>50000,
"ending_balance_in_cents"=>0,
"gateway_used"=>"digital_river",
"gateway_transaction_id"=>"3daa894a-77e5-4bd9-88b9-8e6dd1e84185",
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>154,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>1553,
"customer_id"=>708,
"item_name"=>nil,
"period_range_start"=>nil,
"period_range_end"=>nil,
"currency"=>"USD",
"exchange_rate"=>1,
"component_handle"=>nil,
"component_price_point_id"=>nil,
"component_price_point_handle"=>nil,
"parent_id"=>nil,
"role"=>nil,
"card_number"=>"XXXX-XXXX-XXXX-1111",
"card_expiration"=>"01/2029",
"card_type"=>"visa",
"refunded_amount_in_cents"=>0,
"invoice_id"=>nil},
"event_id"=>5432}Back to list of Payload Examples
prepaid_subscription_balance_change payload
"subscription"=>
{"id"=>129431,
"state"=>"expired",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Mon, 09 Nov 2020 11:33:10 MST -07:00,
"created_at"=>Mon, 09 Nov 2020 11:33:09 MST -07:00,
"updated_at"=>Mon, 09 Nov 2020 11:57:26 MST -07:00,
"expires_at"=>Mon, 09 Nov 2020 11:37:00 MST -07:00,
"balance_in_cents"=>0,
"current_period_ends_at"=>nil,
"next_assessment_at"=>nil,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"next_product_handle"=>nil,
"cancel_at_end_of_period"=>nil,
"payment_collection_method"=>"prepaid",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>nil,
"previous_state"=>"active",
"signup_payment_id"=>3129166,
"signup_revenue"=>"30.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>22000,
"product_price_in_cents"=>0,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>nil,
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>nil,
"payer_id"=>nil,
"receives_invoice_emails"=>nil,
"product_price_point_id"=>16695,
"next_product_price_point_id"=>nil,
"credit_balance_in_cents"=>0,
"prepayment_balance_in_cents"=>22000,
"net_terms"=>nil,
"stored_credential_transaction_id"=>nil,
"locale"=>nil,
"reference"=>nil,
"currency"=>"USD",
"on_hold_at"=>nil,
"scheduled_cancellation_at"=>nil,
"customer"=>
{"id"=>214718,
"first_name"=>"Baylee",
"last_name"=>"Brekke",
"organization"=>"Hickle, Strosin and Rice",
"email"=>"Caden20@example.com",
"created_at"=>Mon, 09 Nov 2020 11:32:39 MST -07:00,
"updated_at"=>Mon, 09 Nov 2020 11:33:11 MST -07:00,
"reference"=>nil,
"address"=>"7563 Gutkowski Crescent",
"address_2"=>"Apt. 499",
"city"=>"West Michael",
"state"=>"AZ",
"zip"=>"44635-5049",
"country"=>"US",
"phone"=>"270-305-7838",
"portal_invite_last_sent_at"=>Mon, 09 Nov 2020 11:33:11 MST -07:00,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>Mon, 09 Nov 2020 11:33:11 MST -07:00,
"vat_number"=>nil,
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"product"=>
{"id"=>17900,
"name"=>"expires",
"handle"=>nil,
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>1,
"expiration_interval_unit"=>"month",
"created_at"=>Mon, 09 Nov 2020 11:29:50 MST -07:00,
"updated_at"=>Mon, 09 Nov 2020 11:29:50 MST -07:00,
"price_in_cents"=>0,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>false,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"",
"tax_code"=>"",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"",
"default_product_price_point_id"=>16695,
"request_billing_address"=>false,
"require_billing_address"=>false,
"require_shipping_address"=>false,
"product_price_point_id"=>16695,
"product_price_point_name"=>"Original",
"product_price_point_handle"=>"uuid:79d63630-04e7-0139-d7d7-029b6d08343c",
"product_family"=>
{"id"=>10712,
"name"=>"Billing Plans",
"description"=>nil,
"handle"=>"acme-inc-billing-plans",
"accounting_code"=>nil,
"created_at"=>Mon, 27 Apr 2020 07:36:52 MDT -06:00,
"updated_at"=>Mon, 27 Apr 2020 07:36:52 MDT -06:00},
"public_signup_pages"=>[]},
"credit_card"=>
{"id"=>124033,
"first_name"=>"Ciara",
"last_name"=>"Heathcote",
"masked_card_number"=>"XXXX-XXXX-XXXX-1",
"card_type"=>"bogus",
"expiration_month"=>11,
"expiration_year"=>2021,
"customer_id"=>214718,
"current_vault"=>"bogus",
"vault_token"=>"1",
"billing_address"=>"1816 Brekke Wall",
"billing_city"=>"East Milo",
"billing_state"=>"IN",
"billing_zip"=>"00451-1348",
"billing_country"=>"US",
"customer_vault_token"=>nil,
"billing_address_2"=>"Apt. 650",
"payment_type"=>"credit_card",
"disabled"=>false,
"site_gateway_setting_id"=>nil},
"prepaid_configuration"=>
{"id"=>624,
"initial_funding_amount_in_cents"=>3000,
"auto_replenish"=>true,
"replenish_to_amount_in_cents"=>8000,
"replenish_threshold_amount_in_cents"=>3000},
"group"=>nil},
"reason"=>"usage changed",
"current_account_balance_in_cents"=>22000,
"event_id"=>4917496}Back to list of Payload Examples
prepaid_usage payload
"component"=>
{"id"=>957864,
"kind"=>"prepaid_usage_component",
"name"=>"Minutes",
"unit_name"=>"minutes",
"handle"=>nil},
"subscription"=>{"id"=>32304660, "name"=>"Mario Smith"},
"product"=>{"id"=>4607690, "name"=>"Silver Plan"},
"memo"=>"",
"timestamp"=>"2020-04-28T18:34:36Z",
"price_point_id"=>821647,
"previous_unit_balance"=>"0.0",
"new_unit_balance"=>15,
"usage_quantity"=>15,
"previous_overage_unit_balance"=>"0.0",
"new_overage_unit_balance"=>5,
"overage_usage_quantity"=>5,
"event_id"=>1064815585}Back to list of Payload Examples
proforma_invoice_issued payload
"site"=>{"id"=>51836, "subdomain"=>"subroll"},
"subscription"=>
{"id"=>39169926,
"current_period_ends_at"=>Sat, 12 Jun 2021 11:48:12 CDT -05:00},
"proforma_invoice"=>
{"uid"=>"pro_9gb7qdmvmyy7y",
"number"=>"45",
"role"=>"proforma_adhoc",
"delivery_date"=>"2021-06-12",
"created_at"=>Thu, 10 Jun 2021 14:03:56 CDT -05:00,
"due_amount"=>"$30,124.00",
"paid_amount"=>"$0.00",
"tax_amount"=>"$0.00",
"total_amount"=>"$30,124.00",
"product_name"=>"trial ",
"line_items"=>
{"0"=>
{"uid"=>"li_9gb7qdmyc4cv7",
"title"=>"trial ",
"description"=>"12 Jun 2021 - 12 Jul 2021",
"quantity"=>1,
"unit_price"=>"$1.00",
"period_range_start"=>"2021-06-12",
"period_range_end"=>"2021-07-12",
"amount"=>"$1.00",
"pricing_details_index"=>nil,
"pricing_details"=>{},
"tax_code"=>nil,
"tax_amount"=>"0.0"},
"1"=>
{"uid"=>"li_9gb7qdmyz5zw6",
"title"=>"Quantity Component",
"description"=>"12 Jun 2021 - 12 Jul 2021",
"quantity"=>30000,
"unit_price"=>"$1.00",
"period_range_start"=>"2021-06-12",
"period_range_end"=>"2021-07-12",
"amount"=>"$30,000.00",
"pricing_details_index"=>nil,
"pricing_details"=>
{"0"=>{"label"=>"30000 at $1.00 each", "amount"=>"$30,000.00"}},
"tax_code"=>nil,
"tax_amount"=>"0.0"},
"2"=>
{"uid"=>"li_9gb7qdmzyd8hj",
"title"=>"onoff",
"description"=>"12 Jun 2021 - 12 Jul 2021",
"quantity"=>1,
"unit_price"=>"$123.00",
"period_range_start"=>"2021-06-12",
"period_range_end"=>"2021-07-12",
"amount"=>"$123.00",
"pricing_details_index"=>nil,
"pricing_details"=>
{"0"=>{"label"=>"1 at $123.00 each", "amount"=>"$123.00"}},
"tax_code"=>nil,
"tax_amount"=>"0.0"}}},
"event_id"=>1504857570}Back to list of Payload Examples
refund_failure payload
"customer_id"=>15826583,
"customer_email"=>"doristester@example.com",
"customer_name"=>"Doris Tester",
"customer_reference"=>"123456789",
"errors"=>
["Cannot process a refund for a subscription without a payment profile."],
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"gateway_used"=>"bogus",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"memo"=>"Refund for services",
"payment_amount_in_cents"=>6000,
"payment_id"=>173961106,
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"subscription_id"=>16372192,
"timestamp"=>"2017-02-13T19:57:13Z",
"event_id"=>377635202,
"currency"=>"USD"}Back to list of Payload Examples
refund_success payload
"amount_in_cents"=>16000,
"customer_id"=>15826583,
"customer_email"=>"doristester@example.com",
"customer_name"=>"Doris Tester",
"customer_reference"=>"123456789",
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"gateway_used"=>"bogus",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"memo"=>"Refund for services",
"payment_amount_in_cents"=>16000,
"payment_id"=>173973102,
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"subscription_id"=>16372192,
"timestamp"=>"2017-02-13T19:56:40Z",
"event_id"=>377635077,
"currency"=>"USD"}Back to list of Payload Examples
renewal_failure payload
{"id"=>16372192,
"state"=>"past_due",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Mon, 13 Feb 2017 11:50:57 EST -05:00,
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 13:28:06 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>16000,
"current_period_ends_at"=>Mon, 13 Mar 2017 14:28:05 EDT -04:00,
"next_assessment_at"=>Tue, 14 Feb 2017 13:28:06 EST -05:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 13 Feb 2017 13:28:05 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>173961106,
"signup_revenue"=>"60.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>6000,
"product_price_in_cents"=>5000,
"product_version_number"=>1,
"payment_type"=>nil,
"referral_code"=>"cz8wdq",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"currency"=>"USD",
"customer"=>
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"organization"=>"Acme",
"email"=>"doris@example.com",
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"reference"=>"123456789",
"address"=>"123 Anywhere Street",
"address_2"=>"",
"city"=>"Boston",
"state"=>"MA",
"zip"=>"02120",
"country"=>"US",
"phone"=>"555-555-1212",
"portal_invite_last_sent_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"portal_invite_last_accepted_at"=>nil,
"verified"=>nil,
"portal_customer_created_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil},
"product"=>
{"id"=>4442358,
"name"=>"Gold Product",
"handle"=>"gold-product",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Thu, 15 Dec 2016 09:32:36 EST -05:00,
"updated_at"=>Thu, 15 Dec 2016 09:32:36 EST -05:00,
"price_in_cents"=>5000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>306012,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/7dbsnjd8t8cx/gold-product"},
{"id"=>310598,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/ksjh9py5fn5h/gold-product"},
{"id"=>311132,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/kjmks49g8d3d/gold-product"}]}},
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"event_id"=>377601653}Back to list of Payload Examples
renewal_success payload
{"id"=>16327080,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Thu, 09 Feb 2017 11:42:28 EST -05:00,
"created_at"=>Thu, 09 Feb 2017 11:42:26 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 12:03:41 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>5667,
"current_period_ends_at"=>Wed, 08 Mar 2017 12:00:00 EST -05:00,
"next_assessment_at"=>Wed, 08 Mar 2017 12:00:00 EST -05:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>"8",
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 13 Feb 2017 12:00:00 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>0,
"signup_revenue"=>"0.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>0,
"product_price_in_cents"=>6900,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"6zcsxw",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"currency"=>"USD",
"customer"=>
{"id"=>15780191,
"first_name"=>"Test ",
"last_name"=>"Monthly",
"organization"=>"",
"email"=>"test@example.com",
"created_at"=>Thu, 09 Feb 2017 11:42:26 EST -05:00,
"updated_at"=>Thu, 09 Feb 2017 11:42:29 EST -05:00,
"reference"=>nil,
"address"=>nil,
"address_2"=>nil,
"city"=>nil,
"state"=>nil,
"zip"=>nil,
"country"=>nil,
"phone"=>"",
"portal_invite_last_sent_at"=>Thu, 09 Feb 2017 11:42:29 EST -05:00,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>Thu, 09 Feb 2017 11:42:29 EST -05:00,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil},
"product"=>
{"id"=>4458204,
"name"=>"Monthly product ",
"handle"=>"monthly-product",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Wed, 08 Feb 2017 16:48:54 EST -05:00,
"updated_at"=>Wed, 08 Feb 2017 16:48:54 EST -05:00,
"price_in_cents"=>6900,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>312067,
"return_url"=>nil,
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/5x8sbq29vgkn/monthly-product"},
{"id"=>312068,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/vsmzkwvmfqqx/monthly-product"}]},
"credit_card"=>
{"id"=>10881632,
"first_name"=>"Test",
"last_name"=>"Page",
"masked_card_number"=>"XXXX-XXXX-XXXX-1",
"card_type"=>"bogus",
"expiration_month"=>1,
"expiration_year"=>2027,
"customer_id"=>15780191,
"current_vault"=>"bogus",
"vault_token"=>"1",
"billing_address"=>nil,
"billing_city"=>nil,
"billing_state"=>nil,
"billing_zip"=>"",
"billing_country"=>nil,
"customer_vault_token"=>nil,
"billing_address_2"=>nil,
"payment_type"=>"credit_card"}},
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"event_id"=>377575304}Back to list of Payload Examples
signup_failure payload
{"id"=>16374036,
"state"=>"failed_to_create",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>nil,
"created_at"=>Mon, 13 Feb 2017 13:08:30 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 13:08:31 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>6900,
"current_period_ends_at"=>Wed, 08 Mar 2017 12:00:00 EST -05:00,
"next_assessment_at"=>nil,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>"8",
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 13 Feb 2017 13:08:30 EST -05:00,
"previous_state"=>"failed_to_create",
"signup_payment_id"=>173970546,
"signup_revenue"=>"69.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>0,
"product_price_in_cents"=>6900,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"k9f3h5",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"payer_id"=>15828506,
"currency"=>"USD",
"customer"=>
{"id"=>15828506,
"first_name"=>"Joe",
"last_name"=>"Tester",
"organization"=>"Acme",
"email"=>"joetester@example.com",
"created_at"=>Mon, 13 Feb 2017 13:08:30 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 13:08:30 EST -05:00,
"reference"=>nil,
"address"=>nil,
"address_2"=>nil,
"city"=>nil,
"state"=>nil,
"zip"=>nil,
"country"=>nil,
"phone"=>"555-555-1212",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false,
"parent_id"=>nil},
"product"=>
{"id"=>4458204,
"name"=>"Monthly product ",
"handle"=>"monthly-product",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Wed, 08 Feb 2017 16:48:54 EST -05:00,
"updated_at"=>Wed, 08 Feb 2017 16:48:54 EST -05:00,
"price_in_cents"=>6900,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>312067,
"return_url"=>nil,
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/5x8sbq29vgkn/monthly-product"},
{"id"=>312068,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/vsmzkwvmfqqx/monthly-product"}]},
"credit_card"=>
{"id"=>10913241,
"first_name"=>"Joe",
"last_name"=>"Tester",
"masked_card_number"=>"XXXX-XXXX-XXXX-2",
"card_type"=>"bogus",
"expiration_month"=>1,
"expiration_year"=>2027,
"customer_id"=>15828506,
"current_vault"=>"bogus",
"vault_token"=>"2",
"billing_address"=>nil,
"billing_city"=>nil,
"billing_state"=>nil,
"billing_zip"=>"02120",
"billing_country"=>nil,
"customer_vault_token"=>nil,
"billing_address_2"=>nil,
"payment_type"=>"credit_card"}},
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"event_id"=>377594843}Back to list of Payload Examples
signup_success payload
{"id"=>16372192,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Mon, 13 Feb 2017 11:50:57 EST -05:00,
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 11:50:57 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>6000,
"current_period_ends_at"=>Mon, 13 Mar 2017 12:50:55 EDT -04:00,
"next_assessment_at"=>Mon, 13 Mar 2017 12:50:55 EDT -04:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>173961106,
"signup_revenue"=>"60.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>0,
"product_price_in_cents"=>5000,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"cz8wdq",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>64,
"payer_id"=>15826583,
"currency"=>"USD",
"customer"=>
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"organization"=>"Acme",
"email"=>"doris@example.com",
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"reference"=>"123456789",
"address"=>"123 Anywhere Street",
"address_2"=>"",
"city"=>"Boston",
"state"=>"MA",
"zip"=>"02120",
"country"=>"US",
"phone"=>"555-555-1212",
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"vat_number"=>"123456789"
"verified"=>nil,
"portal_customer_created_at"=>nil,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false},
"product"=>
{"id"=>4442358,
"name"=>"Gold Product",
"handle"=>"gold-product",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Thu, 15 Dec 2016 09:32:36 EST -05:00,
"updated_at"=>Thu, 15 Dec 2016 09:32:36 EST -05:00,
"price_in_cents"=>5000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"tax_code"=>"PC040100",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>306012,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/7dbsnjd8t8cx/gold-product"},
{"id"=>310598,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/ksjh9py5fn5h/gold-product"},
{"id"=>311132,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/kjmks49g8d3d/gold-product"}]},
"credit_card"=>
{"id"=>10911728,
"first_name"=>"Doris",
"last_name"=>"Tester",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>1,
"expiration_year"=>2027,
"customer_id"=>15826583,
"current_vault"=>"bogus",
"vault_token"=>"1",
"billing_address"=>"123 Anywhere Street",
"billing_city"=>"Boston",
"billing_state"=>"MA",
"billing_zip"=>"02120",
"billing_country"=>"US",
"customer_vault_token"=>nil,
"billing_address_2"=>"",
"payment_type"=>"credit_card"}},
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"event_id"=>377569865}Back to list of Payload Examples
statement_closed payload
"subscription"=>
{"id"=>16372192, "state"=>"past_due", "balance_in_cents"=>16000, "currency"=>"USD"},
"customer"=>
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"reference"=>"123456789",
"organization"=>"Acme",
"address"=>"123 Anywhere Street",
"address_2"=>"",
"city"=>"Boston",
"state"=>"MA",
"zip"=>"02120",
"country"=>"US",
"email"=>"doris@example.com",
"phone"=>"555-555-1212"},
"statement"=>
{"closed_at"=>Mon, 13 Feb 2017 13:28:06 EST -05:00,
"created_at"=>Mon, 13 Feb 2017 13:15:22 EST -05:00,
"id"=>85705040,
"opened_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"settled_at"=>nil,
"subscription_id"=>16372192,
"updated_at"=>Mon, 13 Feb 2017 13:28:06 EST -05:00,
"starting_balance_in_cents"=>0,
"ending_balance_in_cents"=>16000,
"total_in_cents"=>16000,
"memo"=>"We thank you for your continued business!",
"events"=>
{"0"=>
{"id"=>377601643,
"key"=>"billing_date_change",
"message"=>
"Billing date changed on Doris Tester's subscription to Gold Product from 03/13/2017 to 02/13/2017"}},
"transactions"=>
{"0"=>
{"id"=>173970824,
"subscription_id"=>16372192,
"type"=>"Adjustment",
"kind"=>nil,
"transaction_type"=>"adjustment",
"success"=>true,
"amount_in_cents"=>10000,
"memo"=>"100",
"created_at"=>Mon, 13 Feb 2017 13:15:22 EST -05:00,
"starting_balance_in_cents"=>0,
"ending_balance_in_cents"=>10000,
"gateway_used"=>nil,
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>4442358,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>85705040,
"customer_id"=>15826583,
"currency"=>"USD"},
"1"=>
{"id"=>173972839,
"subscription_id"=>16372192,
"type"=>"Charge",
"kind"=>"baseline",
"transaction_type"=>"charge",
"success"=>true,
"amount_in_cents"=>5000,
"memo"=>"Gold Product (02/13/2017 - 03/13/2017)",
"created_at"=>Mon, 13 Feb 2017 13:28:06 EST -05:00,
"starting_balance_in_cents"=>10000,
"ending_balance_in_cents"=>15000,
"gateway_used"=>nil,
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>4442358,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>85705040,
"customer_id"=>15826583,
"original_amount_in_cents"=>nil,
"discount_amount_in_cents"=>nil,
"taxable_amount_in_cents"=>nil,
"currency"=>"USD",
"taxations"=>{}},
"2"=>
{"id"=>173972840,
"subscription_id"=>16372192,
"type"=>"Charge",
"kind"=>"quantity_based_component",
"transaction_type"=>"charge",
"success"=>true,
"amount_in_cents"=>1000,
"memo"=>"Quantity Component: 10 Quantity Components",
"created_at"=>Mon, 13 Feb 2017 13:28:06 EST -05:00,
"starting_balance_in_cents"=>15000,
"ending_balance_in_cents"=>16000,
"gateway_used"=>nil,
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>4442358,
"tax_id"=>nil,
"component_id"=>375250,
"statement_id"=>85705040,
"customer_id"=>15826583,
"original_amount_in_cents"=>nil,
"discount_amount_in_cents"=>nil,
"taxable_amount_in_cents"=>nil,
"currency"=>"USD",
"taxations"=>{}},
"3"=>
{"id"=>173972841,
"subscription_id"=>16372192,
"type"=>"InfoTransaction",
"kind"=>nil,
"transaction_type"=>"info",
"success"=>false,
"amount_in_cents"=>0,
"memo"=>"No credit card was on file for the $160.00 balance",
"created_at"=>Mon, 13 Feb 2017 13:28:06 EST -05:00,
"starting_balance_in_cents"=>16000,
"ending_balance_in_cents"=>16000,
"gateway_used"=>nil,
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>4442358,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>85705040,
"customer_id"=>15826583,
"currency"=>"USD"}},
"future_payments"=>{}},
"product"=>{"id"=>4442358, "name"=>"Gold Product"},
"product_family"=>{"id"=>986840, "name"=>"Acme Products"},
"payment_profile"=>{},
"event_id"=>377601654}Back to list of Payload Examples
statement_settled payload
"subscription"=>{"id"=>16372192, "state"=>"active", "balance_in_cents"=>0, "currency"=>"USD"},
"customer"=>
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"reference"=>"123456789",
"organization"=>"Acme",
"address"=>"123 Anywhere Street",
"address_2"=>"",
"city"=>"Boston",
"state"=>"MA",
"zip"=>"02120",
"country"=>"US",
"email"=>"doris@example.com",
"phone"=>"555-555-1212"},
"statement"=>
{"closed_at"=>Mon, 13 Feb 2017 13:28:06 EST -05:00,
"created_at"=>Mon, 13 Feb 2017 13:15:22 EST -05:00,
"id"=>85705040,
"opened_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"settled_at"=>Mon, 13 Feb 2017 13:33:13 EST -05:00,
"subscription_id"=>16372192,
"updated_at"=>Mon, 13 Feb 2017 13:33:13 EST -05:00,
"starting_balance_in_cents"=>0,
"ending_balance_in_cents"=>16000,
"total_in_cents"=>16000,
"memo"=>"We thank you for your continued business!",
"events"=>
{"0"=>
{"id"=>377601643,
"key"=>"billing_date_change",
"message"=>
"Billing date changed on Doris Tester's subscription to Gold Product from 03/13/2017 to 02/13/2017"},
"1"=>
{"id"=>377601650,
"key"=>"subscription_state_change",
"message"=>
"State changed on Doris Tester's subscription to Gold Product from active to past_due"},
"2"=>
{"id"=>377601653,
"key"=>"renewal_failure",
"message"=>
"Failed renewal for Doris Tester's subscription to Gold Product"}},
"transactions"=>
{"0"=>
{"id"=>173970824,
"subscription_id"=>16372192,
"type"=>"Adjustment",
"kind"=>nil,
"transaction_type"=>"adjustment",
"success"=>true,
"amount_in_cents"=>10000,
"memo"=>"100",
"created_at"=>Mon, 13 Feb 2017 13:15:22 EST -05:00,
"starting_balance_in_cents"=>0,
"ending_balance_in_cents"=>10000,
"gateway_used"=>nil,
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>4442358,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>85705040,
"customer_id"=>15826583,
"currency"=>"USD"},
"1"=>
{"id"=>173972839,
"subscription_id"=>16372192,
"type"=>"Charge",
"kind"=>"baseline",
"transaction_type"=>"charge",
"success"=>true,
"amount_in_cents"=>5000,
"memo"=>"Gold Product (02/13/2017 - 03/13/2017)",
"created_at"=>Mon, 13 Feb 2017 13:28:06 EST -05:00,
"starting_balance_in_cents"=>10000,
"ending_balance_in_cents"=>15000,
"gateway_used"=>nil,
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"payment_id"=>173973102,
"product_id"=>4442358,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>85705040,
"customer_id"=>15826583,
"original_amount_in_cents"=>nil,
"discount_amount_in_cents"=>nil,
"taxable_amount_in_cents"=>nil,
"currency"=>"USD",
"taxations"=>{}},
"2"=>
{"id"=>173972840,
"subscription_id"=>16372192,
"type"=>"Charge",
"kind"=>"quantity_based_component",
"transaction_type"=>"charge",
"success"=>true,
"amount_in_cents"=>1000,
"memo"=>"Quantity Component: 10 Quantity Components",
"created_at"=>Mon, 13 Feb 2017 13:28:06 EST -05:00,
"starting_balance_in_cents"=>15000,
"ending_balance_in_cents"=>16000,
"gateway_used"=>nil,
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"payment_id"=>173973102,
"product_id"=>4442358,
"tax_id"=>nil,
"component_id"=>375250,
"statement_id"=>85705040,
"customer_id"=>15826583,
"original_amount_in_cents"=>nil,
"discount_amount_in_cents"=>nil,
"taxable_amount_in_cents"=>nil,
"currency"=>"USD",
"taxations"=>{}},
"3"=>
{"id"=>173972841,
"subscription_id"=>16372192,
"type"=>"InfoTransaction",
"kind"=>nil,
"transaction_type"=>"info",
"success"=>false,
"amount_in_cents"=>0,
"memo"=>"No credit card was on file for the $160.00 balance",
"created_at"=>Mon, 13 Feb 2017 13:28:06 EST -05:00,
"starting_balance_in_cents"=>16000,
"ending_balance_in_cents"=>16000,
"gateway_used"=>nil,
"gateway_transaction_id"=>nil,
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>4442358,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>85705040,
"customer_id"=>15826583,
"currency"=>"USD"}},
"future_payments"=>
{"0"=>
{"id"=>173973102,
"subscription_id"=>16372192,
"type"=>"Payment",
"kind"=>nil,
"transaction_type"=>"payment",
"success"=>true,
"amount_in_cents"=>16000,
"memo"=>"Doris Tester - Gold Product: Renewal payment",
"created_at"=>Mon, 13 Feb 2017 13:33:13 EST -05:00,
"starting_balance_in_cents"=>16000,
"ending_balance_in_cents"=>0,
"gateway_used"=>"bogus",
"gateway_transaction_id"=>"53433",
"gateway_order_id"=>nil,
"payment_id"=>nil,
"product_id"=>4442358,
"tax_id"=>nil,
"component_id"=>nil,
"statement_id"=>85706001,
"customer_id"=>15826583,
"card_number"=>"XXXX-XXXX-XXXX-1111",
"card_expiration"=>"02/2018",
"card_type"=>"visa",
"refunded_amount_in_cents"=>0}}},
"product"=>{"id"=>4442358, "name"=>"Gold Product"},
"product_family"=>{"id"=>986840, "name"=>"Acme Products"},
"payment_profile"=>
{"id"=>10914352,
"first_name"=>"Doris",
"last_name"=>"Tester",
"billing_address"=>"",
"billing_address_2"=>"",
"billing_city"=>"",
"billing_country"=>"",
"billing_state"=>"",
"billing_zip"=>""},
"event_id"=>377602845}Back to list of Payload Examples
subscription_bank_account_update payload
{"site"=>{"id"=>60050, "subdomain"=>"chargify-sandbox-141"},
"subscription"=>{"id"=>58501928, "state"=>"active", "balance_in_cents"=>442},
"product"=>
{"id"=>6316229,
"name"=>"Base Subscription",
"product_family_id"=>2417171,
"product_family_name"=>"Billing Scenario Testing"},
"customer"=>
{"id"=>59176626,
"first_name"=>"Samara",
"last_name"=>"Hills",
"reference"=>nil,
"organization"=>"Becker - Lynch",
"email"=>"Jesus.Jacobs@example.org"},
"previous_payment_profile"=>{},
"updated_payment_profile"=>
{"id"=>50298431,
"first_name"=>"John",
"last_name"=>"Smith",
"billing_address"=>"123 main st",
"billing_address_2"=>nil,
"billing_city"=>"Roseville",
"billing_state"=>"CA",
"billing_zip"=>"95747",
"billing_country"=>"US",
"bank_name"=>"Chase",
"masked_bank_routing_number"=>"XXXX1111",
"masked_bank_account_number"=>"XXXX1111",
"bank_account_holder_type"=>"personal",
"current_vault"=>"bogus",
"vault_token"=>"4111111111111111",
"customer_vault_token"=>nil},
"event_id"=>2946290595}
Back to list of Payload Examples
subscription_card_update payload
"subscription"=>{"id"=>16372192, "state"=>"active", "balance_in_cents"=>0},
"product"=>
{"id"=>4442358,
"name"=>"Gold Product",
"product_family_id"=>986840,
"product_family_name"=>"Acme Products"},
"customer"=>
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"reference"=>"123456789",
"organization"=>"Acme",
"email"=>"doris@example.com"},
"previous_payment_profile"=>{},
"updated_payment_profile"=>
{"id"=>10914352,
"first_name"=>"Doris",
"last_name"=>"Tester",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>2,
"expiration_year"=>2018,
"current_vault"=>"bogus",
"vault_token"=>"1",
"customer_vault_token"=>nil,
"billing_address"=>"",
"billing_address_2"=>"",
"billing_city"=>"",
"billing_state"=>"",
"billing_zip"=>"",
"billing_country"=>""},
"event_id"=>377602844}Back to list of Payload Examples
subscription_group_card_update payload
"subscription_group"=>{"uid"=>"grp_96w3wg7hhnbjk", "state"=>"active"},
"customer"=>
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"reference"=>"123456789",
"organization"=>"Acme",
"email"=>"doris@example.com"},
"previous_payment_profile"=>{},
"updated_payment_profile"=>
{"id"=>10914352,
"first_name"=>"Doris",
"last_name"=>"Tester",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>2,
"expiration_year"=>2018,
"current_vault"=>"bogus",
"vault_token"=>"1",
"customer_vault_token"=>nil,
"billing_address"=>"",
"billing_address_2"=>"",
"billing_city"=>"",
"billing_state"=>"",
"billing_zip"=>"",
"billing_country"=>""},
"event_id"=>377602844}Back to list of Payload Examples
subscription_group_signup_failure payload
{"site"=>{"id"=>60050, "subdomain"=>"chargify-sandbox-141"},
"subscription_group"=>
{"payer_attributes"=>
{"first_name"=>"John",
"last_name"=>"Doe",
"email"=>"john@example.com",
"organization"=>"Acme, Inc"},
"credit_card_attributes"=>
{"full_number"=>"3", "expiration_month"=>"12", "expiration_year"=>"2031"},
"subscriptions"=>
[{"product_id"=>6323196, "primary"=>true},
{"product_id"=>6323196},
{"product_id"=>6323196}]},
"customer"=>nil,
"event_id"=>2948348361}
Back to list of Payload Examples
subscription_group_signup_success payload
{"site"=>{"id"=>60050, "subdomain"=>"chargify-sandbox-141"},
"subscription_group"=>
{"uid"=>"grp_b32ztn6vbyh5q",
"scheme"=>1,
"customer_id"=>64261470,
"payment_profile_id"=>50310133,
"subscription_ids"=>[63100002, 63100003, 63100004],
"primary_subscription_id"=>63100002,
"next_assessment_at"=>Sun, 09 Apr 2023 10:43:49 PDT -07:00,
"state"=>"active",
"cancel_at_end_of_period"=>false},
"customer"=>
{"id"=>64261470,
"phone"=>nil,
"reference"=>nil,
"email"=>"john@example.com",
"first_name"=>"John",
"last_name"=>"Doe",
"cc_emails"=>nil,
"vat_number"=>nil,
"address"=>nil,
"address_2"=>nil,
"city"=>nil,
"country"=>nil,
"organization"=>"Acme, Inc",
"state"=>nil,
"zip"=>nil,
"parent_id"=>nil,
"created_at"=>Thu, 09 Mar 2023 09:43:49 PST -08:00,
"updated_at"=>Thu, 09 Mar 2023 09:43:49 PST -08:00,
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"tax_exempt"=>false,
"locale"=>nil},
"event_id"=>2948335113}
Back to list of Payload Examples
subscription_prepayment_account_balance_changed payload
{"site"=>{"id"=>60050, "subdomain"=>"chargify-sandbox-141"},
"prepayments_account"=>
{"at_time"=>Wed, 08 Mar 2023 15:18:11 PST -08:00,
"balance_in_cents"=>25000,
"balance_change_in_cents"=>25000},
"prepayments"=>
{"0"=>
{"id"=>816132545,
"applications"=>{},
"amount_in_cents"=>25000,
"external"=>"external",
"memo"=>"A memo is here"}},
"subscription"=>{"id"=>63081463},
"reason"=>"prepayment created",
"event_id"=>2946242689}
Back to list of Payload Examples
subscription_product_change payload
{"id"=>16372192,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Mon, 13 Feb 2017 11:50:57 EST -05:00,
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 13:40:29 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>Thu, 13 Apr 2017 14:28:00 EDT -04:00,
"next_assessment_at"=>Thu, 13 Apr 2017 14:28:00 EDT -04:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 13 Feb 2017 13:28:05 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>173961106,
"signup_revenue"=>"60.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>22000,
"product_price_in_cents"=>4900,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"cz8wdq",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"customer"=>
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"organization"=>"Acme",
"email"=>"doris@example.com",
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"reference"=>"123456789",
"address"=>"123 Anywhere Street",
"address_2"=>"",
"city"=>"Boston",
"state"=>"MA",
"zip"=>"02120",
"country"=>"US",
"phone"=>"555-555-1212",
"portal_invite_last_sent_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"portal_invite_last_accepted_at"=>nil,
"vat_number"=>"123456789"
"verified"=>nil,
"portal_customer_created_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false},
"product"=>
{"id"=>4443536,
"name"=>"Business Monthly",
"handle"=>"pd_plans_v2_business_mn_1_10",
"description"=>"Business Monthly",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Mon, 19 Dec 2016 15:58:09 EST -05:00,
"updated_at"=>Mon, 19 Dec 2016 15:58:09 EST -05:00,
"price_in_cents"=>4900,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>0,
"trial_interval"=>1,
"trial_interval_unit"=>"day",
"archived_at"=>nil,
"require_credit_card"=>false,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>306548,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/jtvkftj84jsq/pd_plans_v2_business_mn_1_10"}]},
"credit_card"=>
{"id"=>10914352,
"first_name"=>"Doris",
"last_name"=>"Tester",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>2,
"expiration_year"=>2018,
"customer_id"=>15826583,
"current_vault"=>"bogus",
"vault_token"=>"1",
"billing_address"=>"",
"billing_city"=>"",
"billing_state"=>"",
"billing_zip"=>"",
"billing_country"=>"",
"customer_vault_token"=>nil,
"billing_address_2"=>"",
"payment_type"=>"credit_card"}},
"previous_product"=>
{"id"=>4442358,
"name"=>"Gold Product",
"handle"=>"gold-product",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Thu, 15 Dec 2016 09:32:36 EST -05:00,
"updated_at"=>Thu, 15 Dec 2016 09:32:36 EST -05:00,
"price_in_cents"=>5000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>306012,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/7dbsnjd8t8cx/gold-product"},
{"id"=>310598,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/ksjh9py5fn5h/gold-product"},
{"id"=>311132,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/kjmks49g8d3d/gold-product"}]},
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"event_id"=>377604632}Back to list of Payload Examples
subscription_service_credit_account_balance_changed payload
{"site"=>{"id"=>60050, "subdomain"=>"chargify-sandbox-141"},
"subscription"=>{"id"=>63081463},
"reason"=>"service credit given",
"service_credits"=>
[{"id"=>1992348,
"invoice_uid"=>nil,
"entry_type"=>"Credit",
"amount_in_cents"=>1000,
"memo"=>"A memo is here"}],
"service_credit_account"=>
{"at_time"=>Wed, 08 Mar 2023 15:17:55 PST -08:00,
"balance_in_cents"=>1000,
"balance_change_in_cents"=>1000},
"event_id"=>2946242578}
Back to list of Payload Examples
subscription_state_change payload
{"id"=>16372192,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Mon, 13 Feb 2017 11:50:57 EST -05:00,
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 13:33:14 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>16000,
"current_period_ends_at"=>Mon, 13 Mar 2017 14:28:05 EDT -04:00,
"next_assessment_at"=>Tue, 14 Feb 2017 13:28:06 EST -05:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 13 Feb 2017 13:28:05 EST -05:00,
"previous_state"=>"past_due",
"signup_payment_id"=>173961106,
"signup_revenue"=>"60.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>6000,
"product_price_in_cents"=>5000,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"cz8wdq",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"customer"=>
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"organization"=>"Acme",
"email"=>"doris@example.com",
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"reference"=>"123456789",
"address"=>"123 Anywhere Street",
"address_2"=>"",
"city"=>"Boston",
"state"=>"MA",
"zip"=>"02120",
"country"=>"US",
"phone"=>"555-555-1212",
"portal_invite_last_sent_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"portal_invite_last_accepted_at"=>nil,
"vat_number"=>"123456789"
"verified"=>nil,
"portal_customer_created_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"vat_number"=>"123456789"
"cc_emails"=>nil,
"tax_exempt"=>false},
"product"=>
{"id"=>4442358,
"name"=>"Gold Product",
"handle"=>"gold-product",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Thu, 15 Dec 2016 09:32:36 EST -05:00,
"updated_at"=>Thu, 15 Dec 2016 09:32:36 EST -05:00,
"price_in_cents"=>5000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>306012,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/7dbsnjd8t8cx/gold-product"},
{"id"=>310598,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/ksjh9py5fn5h/gold-product"},
{"id"=>311132,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/kjmks49g8d3d/gold-product"}]},
"credit_card"=>
{"id"=>10914352,
"first_name"=>"Doris",
"last_name"=>"Tester",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>2,
"expiration_year"=>2018,
"customer_id"=>15826583,
"current_vault"=>"bogus",
"vault_token"=>"1",
"billing_address"=>"",
"billing_city"=>"",
"billing_state"=>"",
"billing_zip"=>"",
"billing_country"=>"",
"customer_vault_token"=>nil,
"billing_address_2"=>"",
"payment_type"=>"credit_card"}},
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"event_id"=>377602840}Back to list of Payload Examples
trial_end_notice payload
"customer"=>
{"id"=>16609933,
"first_name"=>"Chester",
"last_name"=>"Tester",
"reference"=>"4363421",
"organization"=>nil,
"email"=>"chester.tester@example.com"},
"email_sent"=>false,
"estimated_renewal_amount_in_cents"=>2995,
"message"=>
"End of trial for trial ending on 03/23/2017 for Chester Tester's subscription to Monthly Plan",
"payment_profile"=>
{"id"=>12345678,
"first_name"=>"Chester",
"last_name"=>"Tester",
"card_type"=>"master",
"masked_card_number"=>"XXXX-XXXX-XXXX-6404",
"expiration_month"=>10,
"expiration_year"=>2019},
"product"=>
{"id"=>3768589,
"name"=>"Monthly Plan",
"product_family_id"=>453572,
"product_family_name"=>"Forms"},
"subscription"=>
{"id"=>17127660,
"state"=>"trialing",
"current_period_ends_at"=>Thu, 23 Mar 2017 13:58:14 EDT -04:00},
"event_id"=>390281866}Back to list of Payload Examples
upcoming_renewal_notice payload
"customer" => {
"id" => 15146757,
"first_name" => "Katharine",
"last_name" => "Ross",
"reference" => nil,
"organization" => "",
"email" => "kross@example.com"},
"email_sent" => true,
"estimated_renewal_amount_in_cents" => 5000,
"message" =>
"Upcoming renewal notice sent for period ending on 02/20/2017 for Katharine Ross's subscription to Gold Product",
"payment_profile" => {
"id" => 10485399,
"first_name" => "Katharine",
"last_name" => "Ross",
"card_type" => "bogus",
"masked_card_number" => "XXXX-XXXX-XXXX-1",
"expiration_month" => 1,
"expiration_year" => 2026},
"product" => {
"id" => 4442358,
"name" => "Gold Product",
"product_family_id" => 986840,
"product_family_name" => "Acme Products"},
"subscription" => {
"id" => 15690494,
"state" => "active",
"current_period_ends_at" => Mon, 20 Feb 2017 12: 00: 00 EST - 05: 00},
"event_id" => 378968302}Back to list of Payload Examples
upgrade_downgrade_failure payload
{"id"=>16372192,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Mon, 13 Feb 2017 11:50:57 EST -05:00,
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 14:59:39 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>Fri, 17 Feb 2017 14:28:00 EST -05:00,
"next_assessment_at"=>Fri, 17 Feb 2017 14:28:00 EST -05:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 13 Feb 2017 13:28:05 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>173961106,
"signup_revenue"=>"60.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>6000,
"product_price_in_cents"=>4900,
"product_version_number"=>1,
"payment_type"=>nil,
"referral_code"=>"cz8wdq",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"customer"=>
{"id"=>15826583,
"first_name"=>"Doris",
"last_name"=>"Tester",
"organization"=>"Acme",
"email"=>"doristester@example.com",
"created_at"=>Mon, 13 Feb 2017 11:50:55 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 13:42:07 EST -05:00,
"reference"=>"123456789",
"address"=>"123 Anywhere Street",
"address_2"=>"",
"city"=>"Boston",
"state"=>"MA",
"zip"=>"02120",
"country"=>"US",
"phone"=>"555-555-1212",
"portal_invite_last_sent_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>Mon, 13 Feb 2017 11:50:58 EST -05:00,
"vat_number"=>"123456789"
"cc_emails"=>"",
"tax_exempt"=>false},
"product"=>
{"id"=>4443536,
"name"=>"Business Monthly",
"handle"=>"pd_plans_v2_business_mn_1_10",
"description"=>"Business Monthly",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Mon, 19 Dec 2016 15:58:09 EST -05:00,
"updated_at"=>Mon, 19 Dec 2016 15:58:09 EST -05:00,
"price_in_cents"=>4900,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>0,
"trial_interval"=>1,
"trial_interval_unit"=>"day",
"archived_at"=>nil,
"require_credit_card"=>false,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>306548,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/jtvkftj84jsq/pd_plans_v2_business_mn_1_10"}]}},
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"target_product"=>
{"id"=>4458204,
"name"=>"Monthly product ",
"handle"=>"monthly-product",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Wed, 08 Feb 2017 16:48:54 EST -05:00,
"updated_at"=>Wed, 08 Feb 2017 16:48:54 EST -05:00,
"price_in_cents"=>6900,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>"month",
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>312067,
"return_url"=>nil,
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/5x8sbq29vgkn/monthly-product"},
{"id"=>312068,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/vsmzkwvmfqqx/monthly-product"}]},
"event_id"=>377635953}Back to list of Payload Examples
upgrade_downgrade_success payload
{"id"=>16297395,
"state"=>"trialing",
"trial_started_at"=>Mon, 13 Feb 2017 15:00:02 EST -05:00,
"trial_ended_at"=>Tue, 14 Feb 2017 15:00:02 EST -05:00,
"activated_at"=>Wed, 08 Feb 2017 16:23:22 EST -05:00,
"created_at"=>Tue, 07 Feb 2017 16:06:06 EST -05:00,
"updated_at"=>Mon, 13 Feb 2017 15:00:02 EST -05:00,
"expires_at"=>nil,
"balance_in_cents"=>177,
"current_period_ends_at"=>Tue, 14 Feb 2017 15:00:02 EST -05:00,
"next_assessment_at"=>Tue, 14 Feb 2017 15:00:02 EST -05:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"invoice",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Mon, 13 Feb 2017 15:00:01 EST -05:00,
"previous_state"=>"active",
"signup_payment_id"=>173249657,
"signup_revenue"=>"0.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>0,
"product_price_in_cents"=>4900,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>"j63942",
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"product_price_point_id"=>1,
"next_product_price_point_id"=>nil,
"customer"=>
{"id"=>15751842,
"first_name"=>"Steve",
"last_name"=>"Test",
"organization"=>"",
"email"=>"steve@example.com",
"created_at"=>Tue, 07 Feb 2017 16:06:06 EST -05:00,
"updated_at"=>Tue, 07 Feb 2017 16:06:10 EST -05:00,
"reference"=>nil,
"address"=>nil,
"address_2"=>nil,
"city"=>nil,
"state"=>nil,
"zip"=>nil,
"country"=>nil,
"phone"=>"",
"portal_invite_last_sent_at"=>Tue, 07 Feb 2017 16:06:10 EST -05:00,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>Tue, 07 Feb 2017 16:06:10 EST -05:00,
"cc_emails"=>nil,
"tax_exempt"=>false},
"product"=>
{"id"=>4443536,
"name"=>"Business Monthly",
"handle"=>"pd_plans_v2_business_mn_1_10",
"description"=>"Business Monthly",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Mon, 19 Dec 2016 15:58:09 EST -05:00,
"updated_at"=>Mon, 19 Dec 2016 15:58:09 EST -05:00,
"price_in_cents"=>4900,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>0,
"trial_interval"=>1,
"trial_interval_unit"=>"day",
"archived_at"=>nil,
"require_credit_card"=>false,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>306548,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/jtvkftj84jsq/pd_plans_v2_business_mn_1_10"}]},
"credit_card"=>
{"id"=>10865912,
"first_name"=>"Steve",
"last_name"=>"Test",
"masked_card_number"=>"XXXX-XXXX-XXXX-1",
"card_type"=>"bogus",
"expiration_month"=>1,
"expiration_year"=>2027,
"customer_id"=>15751842,
"current_vault"=>"bogus",
"vault_token"=>"1",
"billing_address"=>nil,
"billing_city"=>nil,
"billing_state"=>nil,
"billing_zip"=>"",
"billing_country"=>nil,
"customer_vault_token"=>nil,
"billing_address_2"=>nil,
"payment_type"=>"credit_card"}},
"site"=>{"id"=>31615, "subdomain"=>"general-goods"},
"previous_product"=>
{"id"=>4453830,
"name"=>"Trial No obligation",
"handle"=>"trial-no-obligation",
"description"=>"",
"accounting_code"=>"",
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>"never",
"created_at"=>Mon, 23 Jan 2017 09:53:23 EST -05:00,
"updated_at"=>Thu, 26 Jan 2017 13:35:29 EST -05:00,
"price_in_cents"=>1000,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>0,
"trial_interval"=>1,
"trial_interval_unit"=>"day",
"archived_at"=>nil,
"require_credit_card"=>false,
"return_params"=>"",
"taxable"=>false,
"update_return_url"=>"http://www.example.com",
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>"id={subscription_id}&ref={customer_reference}",
"default_product_price_point_id"=>1,
"product_price_point_id"=>1,
"product_price_point_handle"=>nil,
"product_family"=>
{"id"=>986840,
"name"=>"Acme Products",
"description"=>"",
"handle"=>"acme-products",
"accounting_code"=>nil},
"public_signup_pages"=>
[{"id"=>310559,
"return_url"=>"",
"return_params"=>"",
"url"=>
"https://general-goods.chargifypay.com/subscribe/ngbsvxv4hq7q/trial-no-obligation"}]},
"event_id"=>377636059}Back to list of Payload Examples
pending_cancellation_change payload
"subscription"=>
{"id"=>13,
"state"=>"active",
"trial_started_at"=>nil,
"trial_ended_at"=>nil,
"activated_at"=>Sat, 01 Feb 2020 10:38:50 EST -05:00,
"created_at"=>Sat, 01 Feb 2020 10:38:49 EST -05:00,
"updated_at"=>Fri, 10 Apr 2020 04:22:55 EDT -04:00,
"expires_at"=>nil,
"balance_in_cents"=>0,
"current_period_ends_at"=>Thu, 07 May 2020 04:33:39 EDT -04:00,
"next_assessment_at"=>Thu, 07 May 2020 04:33:39 EDT -04:00,
"canceled_at"=>nil,
"cancellation_message"=>nil,
"next_product_id"=>nil,
"next_product_handle"=>nil,
"cancel_at_end_of_period"=>false,
"payment_collection_method"=>"automatic",
"snap_day"=>nil,
"cancellation_method"=>nil,
"current_period_started_at"=>Tue, 07 Apr 2020 04:33:39 EDT -04:00,
"previous_state"=>"canceled",
"signup_payment_id"=>0,
"signup_revenue"=>"0.00",
"delayed_cancel_at"=>nil,
"coupon_code"=>nil,
"total_revenue_in_cents"=>31918,
"product_price_in_cents"=>29900,
"product_version_number"=>1,
"payment_type"=>"credit_card",
"referral_code"=>nil,
"coupon_use_count"=>nil,
"coupon_uses_allowed"=>nil,
"reason_code"=>nil,
"automatically_resume_at"=>nil,
"coupon_codes"=>[],
"offer_id"=>nil,
"payer_id"=>8,
"receives_invoice_emails"=>nil,
"product_price_point_id"=>114,
"next_product_price_point_id"=>nil,
"credit_balance_in_cents"=>0,
"prepayment_balance_in_cents"=>0,
"net_terms"=>2,
"stored_credential_transaction_id"=>nil,
"locale"=>nil,
"reference"=>nil,
"currency"=>"USD",
"customer"=>
{"id"=>8,
"first_name"=>"Marty",
"last_name"=>"McFly",
"organization"=>nil,
"email"=>"timetraveller1985@example.com",
"created_at"=>Sat, 01 Feb 2020 10:40:43 EST -05:00,
"updated_at"=>Fri, 03 Apr 2020 05:58:47 EDT -04:00,
"reference"=>nil,
"address"=>"100 Shipping St.",
"address_2"=>"Apt 200",
"city"=>"Pleasantville",
"state"=>"NC",
"zip"=>"12345",
"country"=>"US",
"phone"=>nil,
"portal_invite_last_sent_at"=>nil,
"portal_invite_last_accepted_at"=>nil,
"verified"=>false,
"portal_customer_created_at"=>nil,
"vat_number"=>nil,
"cc_emails"=>"john@example.com, sue@example.com",
"tax_exempt"=>false,
"parent_id"=>nil,
"locale"=>nil},
"product"=>
{"id"=>114,
"name"=>"Professional Plan",
"handle"=>"server-professional",
"description"=>
"Voluptatem et quod delectus ut. Reiciendis repudiandae nemo et doloribus. Maxime velit ut.",
"accounting_code"=>nil,
"request_credit_card"=>true,
"expiration_interval"=>nil,
"expiration_interval_unit"=>nil,
"created_at"=>Sat, 01 Feb 2020 10:40:43 EST -05:00,
"updated_at"=>Sat, 01 Feb 2020 10:40:43 EST -05:00,
"price_in_cents"=>29900,
"interval"=>1,
"interval_unit"=>"month",
"initial_charge_in_cents"=>nil,
"trial_price_in_cents"=>nil,
"trial_interval"=>nil,
"trial_interval_unit"=>nil,
"archived_at"=>nil,
"require_credit_card"=>true,
"return_params"=>nil,
"taxable"=>true,
"update_return_url"=>nil,
"tax_code"=>nil,
"initial_charge_after_trial"=>false,
"version_number"=>1,
"update_return_params"=>nil,
"default_product_price_point_id"=>114,
"product_price_point_id"=>114,
"product_price_point_name"=>"Default",
"product_price_point_handle"=>"uuid:213b0f81-2737-0138-4a11-2cde48001122",
"product_family"=>
{"id"=>29,
"name"=>"Cloud Compute Servers",
"description"=>nil,
"handle"=>"cloud-compute-servers",
"accounting_code"=>nil},
"public_signup_pages"=>[]},
"credit_card"=>
{"id"=>8,
"first_name"=>"Marty",
"last_name"=>"McFly",
"masked_card_number"=>"XXXX-XXXX-XXXX-1111",
"card_type"=>"visa",
"expiration_month"=>12,
"expiration_year"=>2022,
"customer_id"=>8,
"current_vault"=>"",
"vault_token"=>"1",
"billing_address"=>"200 Billing Rd.",
"billing_city"=>"Needham",
"billing_state"=>"MA",
"billing_zip"=>"02494",
"billing_country"=>"US",
"customer_vault_token"=>nil,
"billing_address_2"=>"Suite 100",
"payment_type"=>"credit_card",
"disabled"=>false}},
"cancellation_state"=>"cleared",
"cancels_at"=>nil,
"event_id"=>315}