A P I Exports

List Exported Subscriptions

GET
/api_exports/subscriptions/{batch_id}/rows.json

Lists exported subscriptions for a provided batch_id. Use pagination to control responses returned from the server.

Example: GET https://{subdomain}.chargify.com/api_exports/subscriptions/123/rows?per_page=200&page=1.

Authorization

BasicAuth
AuthorizationBasic <token>

The username is a Maxio Chargify API key. The password is x.

In: header

Path Parameters

batch_id*string

Id of a Batch Job.

Query Parameters

per_page?integer

This parameter indicates how many records to fetch in each request. Default value is 100. The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000.

Range1 <= value <= 10000
Default100
page?integer

Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query page=1.

Range1 <= value
Default1

Response Body

application/json

curl -X GET "https://example.com/api_exports/subscriptions/string/rows.json"
[  {    "id": 0,    "state": "pending",    "balance_in_cents": 0,    "total_revenue_in_cents": 0,    "product_price_in_cents": 0,    "product_version_number": 0,    "current_period_ends_at": "2019-08-24T14:15:22Z",    "next_assessment_at": "2019-08-24T14:15:22Z",    "trial_started_at": "2019-08-24T14:15:22Z",    "trial_ended_at": "2019-08-24T14:15:22Z",    "activated_at": "2019-08-24T14:15:22Z",    "expires_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "cancellation_message": "string",    "cancellation_method": "merchant_ui",    "cancel_at_end_of_period": true,    "canceled_at": "2019-08-24T14:15:22Z",    "current_period_started_at": "2019-08-24T14:15:22Z",    "previous_state": "pending",    "signup_payment_id": 0,    "signup_revenue": "string",    "delayed_cancel_at": "2019-08-24T14:15:22Z",    "coupon_code": "string",    "snap_day": "string",    "payment_collection_method": "automatic",    "customer": {      "first_name": "string",      "last_name": "string",      "email": "string",      "cc_emails": "string",      "organization": "string",      "reference": "string",      "id": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "address": "string",      "address_2": "string",      "city": "string",      "state": "string",      "state_name": "string",      "zip": "string",      "country": "string",      "country_name": "string",      "phone": "string",      "verified": true,      "portal_customer_created_at": "2019-08-24T14:15:22Z",      "portal_invite_last_sent_at": "2019-08-24T14:15:22Z",      "portal_invite_last_accepted_at": "2019-08-24T14:15:22Z",      "tax_exempt": true,      "surcharging": true,      "vat_number": "string",      "vat_country": "string",      "entity_identifier_kind": "vat_eu",      "entity_identifier_value": "string",      "parent_id": 0,      "locale": "string",      "default_subscription_group_uid": "string",      "salesforce_id": "string",      "tax_exempt_reason": "string",      "default_auto_renewal_profile_id": 0,      "maxioid": "string",      "branding_theme_id": 0    },    "product": {      "id": 0,      "name": "string",      "handle": "string",      "description": "string",      "accounting_code": "string",      "request_credit_card": true,      "expiration_interval": 0,      "expiration_interval_unit": "day",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "price_in_cents": 0,      "interval": 0,      "interval_unit": "day",      "initial_charge_in_cents": 0,      "trial_price_in_cents": 0,      "trial_interval": 0,      "trial_interval_unit": "day",      "archived_at": "2019-08-24T14:15:22Z",      "require_credit_card": true,      "return_params": "string",      "taxable": true,      "update_return_url": "string",      "initial_charge_after_trial": true,      "version_number": 0,      "update_return_params": "string",      "product_family": {        "id": 0,        "name": "string",        "handle": "string",        "accounting_code": null,        "description": "string",        "surcharging": true,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "archived_at": "2019-08-24T14:15:22Z"      },      "public_signup_pages": [        {          "id": 0,          "return_url": "string",          "return_params": "string",          "url": "string"        }      ],      "product_price_point_name": "string",      "request_billing_address": true,      "require_billing_address": true,      "require_shipping_address": true,      "tax_code": "string",      "default_product_price_point_id": 0,      "use_site_exchange_rate": true,      "item_category": "string",      "product_price_point_id": 0,      "product_price_point_handle": "string",      "unspsc_code": "string",      "features": [        {          "id": 0,          "feature_template_id": 0,          "feature_key": "string",          "feature_name": "string",          "feature_kind": "access_right",          "value": "string",          "periodicity_interval": 0,          "periodicity_unit": "hour",          "price_point_type": "ProductPricePoint",          "price_point_id": 0,          "archived_at": "2019-08-24T14:15:22Z",          "created_at": "2019-08-24T14:15:22Z",          "updated_at": "2019-08-24T14:15:22Z"        }      ]    },    "credit_card": {      "id": 10088716,      "first_name": "Test",      "last_name": "Subscription",      "masked_card_number": "XXXX-XXXX-XXXX-1",      "card_type": "bogus",      "expiration_month": 1,      "expiration_year": 2022,      "customer_id": 14543792,      "current_vault": "bogus",      "vault_token": "1",      "billing_address": "123 Montana Way",      "billing_city": "Billings",      "billing_state": "MT",      "billing_zip": "59101",      "billing_country": "US",      "customer_vault_token": null,      "billing_address_2": "",      "payment_type": "credit_card",      "site_gateway_setting_id": 1,      "gateway_handle": null    },    "group": {      "uid": "string",      "scheme": 0,      "primary_subscription_id": 0,      "primary": true    },    "bank_account": {      "id": 0,      "first_name": "string",      "last_name": "string",      "customer_id": 0,      "current_vault": "authorizenet",      "vault_token": "string",      "billing_address": "string",      "billing_city": "string",      "billing_state": "string",      "billing_zip": "string",      "billing_country": "string",      "customer_vault_token": "string",      "billing_address_2": "string",      "bank_name": "string",      "masked_bank_routing_number": "string",      "masked_bank_account_number": "string",      "bank_account_type": "checking",      "bank_account_holder_type": "personal",      "payment_type": "bank_account",      "verified": false,      "site_gateway_setting_id": 0,      "gateway_handle": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    },    "payment_type": "string",    "referral_code": "string",    "next_product_id": 0,    "next_product_handle": "string",    "coupon_use_count": 0,    "coupon_uses_allowed": 0,    "reason_code": "string",    "automatically_resume_at": "2019-08-24T14:15:22Z",    "coupon_codes": [      "string"    ],    "offer_id": 0,    "payer_id": 0,    "current_billing_amount_in_cents": 0,    "product_price_point_id": 0,    "product_price_point_type": "catalog",    "next_product_price_point_id": 0,    "net_terms": 0,    "stored_credential_transaction_id": 0,    "reference": "string",    "on_hold_at": "2019-08-24T14:15:22Z",    "prepaid_dunning": true,    "coupons": [      {        "code": "string",        "use_count": 0,        "uses_allowed": 0,        "expires_at": "string",        "recurring": true,        "amount_in_cents": 0,        "percentage": "string"      }    ],    "dunning_communication_delay_enabled": true,    "dunning_communication_delay_time_zone": "string",    "receives_invoice_emails": true,    "locale": "string",    "currency": "string",    "scheduled_cancellation_at": "2019-08-24T14:15:22Z",    "credit_balance_in_cents": 0,    "prepayment_balance_in_cents": 0,    "prepaid_configuration": {      "id": 0,      "initial_funding_amount_in_cents": 0,      "replenish_to_amount_in_cents": 0,      "auto_replenish": true,      "replenish_threshold_amount_in_cents": 0    },    "self_service_page_token": "string"  }]