Returns a dictionary with a data property that contains an array of accounts, starting after the cursor, if used. Each entry in the array is a separate account object. If no more accounts are available, the resulting array will be empty. This request should never return an error.
page_size | integer [ 1 .. 50 ] The maximum number of results to return in a single page. If the specified |
cursor | string A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with |
sort[] | Array of strings A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. |
expand[] | Array of strings Allows you to expand responses by including related object information in a single call. See the 'Expand responses' section of the Quickstart API Tutorial for detailed instructions. |
filter[] | Array of strings A case-sensitive filter on the list. See the 'Filter lists' section of the Quickstart API Tutorial for detailed instructions. |
Default Response
Default Response
curl --request GET --url 'https://rest.apisandbox.zuora.com/v2/accounts' --header 'Authorization: Bearer d8a7f4d2a5ef4c3eba8618cf99593e26' --header 'Content-Type: application/json'
{- "next_page": "string",
- "data": [
- {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": "string",
- "property2": "string"
}, - "custom_objects": {
- "property1": {
- "next_page": "string",
- "data": [
- {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": null,
- "property2": null
}, - "custom_objects": {
- "property1": null,
- "property2": null
}, - "type": "string"
}
]
}, - "property2": {
- "next_page": "string",
- "data": [
- {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": null,
- "property2": null
}, - "custom_objects": {
- "property1": null,
- "property2": null
}, - "type": "string"
}
]
}
}, - "account_number": "A-100001",
- "billing_document_settings": {
- "credit_memo_template_id": "2c92c08b6a8c978f016a9e0084622b62",
- "debit_memo_template_id": "2c92c08c6a8c7e08016a9ec8d72f3ab5",
- "email_documents": "alawrence@zuora.com",
- "print_documents": false,
- "invoice_template_id": "8f64d4d754739d85d0346e00ef77e50d",
- "additional_email": "jdoe@zuora.com"
}, - "batch": "string",
- "bill_cycle_day": 31,
- "bill_to": {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": "string",
- "property2": "string"
}, - "custom_objects": {
- "property1": {
- "next_page": "string",
- "data": [
- {
- "id": null,
- "updated_by_id": null,
- "updated_time": null,
- "created_by_id": null,
- "created_time": null,
- "custom_fields": { },
- "custom_objects": { },
- "type": null
}
]
}, - "property2": {
- "next_page": "string",
- "data": [
- {
- "id": null,
- "updated_by_id": null,
- "updated_time": null,
- "created_by_id": null,
- "created_time": null,
- "custom_fields": { },
- "custom_objects": { },
- "type": null
}
]
}
}, - "address": {
- "line1": "3333 Piedmont Rd NE",
- "line2": "Suite 1150",
- "city": "Atlanta",
- "state": "GA",
- "country": "USA",
- "county": "string",
- "postal_code": "30305"
}, - "first_name": "Amy",
- "home_phone": "(888)976-9056",
- "last_name": "Lawrence",
- "mobile_phone": "(888)101-0011",
- "nickname": "Ami",
- "other_phone": "(888)100-0001",
- "email": "alawrence@gmail.com",
- "tax_region": "Georgia",
- "work_email": "alawrence@zuora.com",
- "work_phone": "(888)976-9056",
- "account_id": "2c92c0f86a8dd422016a9e7a70116b0d"
}, - "sold_to": {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": "string",
- "property2": "string"
}, - "custom_objects": {
- "property1": {
- "next_page": "string",
- "data": [
- {
- "id": null,
- "updated_by_id": null,
- "updated_time": null,
- "created_by_id": null,
- "created_time": null,
- "custom_fields": { },
- "custom_objects": { },
- "type": null
}
]
}, - "property2": {
- "next_page": "string",
- "data": [
- {
- "id": null,
- "updated_by_id": null,
- "updated_time": null,
- "created_by_id": null,
- "created_time": null,
- "custom_fields": { },
- "custom_objects": { },
- "type": null
}
]
}
}, - "address": {
- "line1": "3333 Piedmont Rd NE",
- "line2": "Suite 1150",
- "city": "Atlanta",
- "state": "GA",
- "country": "USA",
- "county": "string",
- "postal_code": "30305"
}, - "first_name": "Amy",
- "home_phone": "(888)976-9056",
- "last_name": "Lawrence",
- "mobile_phone": "(888)101-0011",
- "nickname": "Ami",
- "other_phone": "(888)100-0001",
- "email": "alawrence@gmail.com",
- "tax_region": "Georgia",
- "work_email": "alawrence@zuora.com",
- "work_phone": "(888)976-9056",
- "account_id": "2c92c0f86a8dd422016a9e7a70116b0d"
}, - "communication_profile_id": "2c92c0946a6dffc0016a7faab604299b",
- "crm_id": "1a2b3c4d5e",
- "default_payment_method_id": "8a95b1946b6aeac8718c32aab8c395f",
- "name": "test account",
- "description": "description of test account",
- "parent_account_id": "8ad093f27d6eee80017d6effd7a66759",
- "payment_gateway": "adyen gateway",
- "payment_terms": "Net 30",
- "sequence_set_id": "2c92a4204a6dffc0016a7faab723041c",
- "auto_pay": true,
- "tax_certificate": {
- "company_code": "ABC",
- "id": "string",
- "start_date": "2022-01-01",
- "description": "string",
- "entity_use_code": "string",
- "end_date": "2023-01-01",
- "issuing_jurisdiction": "Georgia",
- "state": "pending",
- "tax_identifier": "DE123456789"
}, - "tax_identifier": {
- "id": "string"
}, - "currency": "USD",
- "sales_rep": "Max",
- "enabled": true,
- "remaining_debit_memo_balance": 10,
- "remaining_invoice_balance": 100,
- "remaining_credit_memo_balance": 50,
- "remaining_payment_balance": 20,
- "bill_to_id": "2c92c0f86a8dd422016a9e7a70116b0d",
- "sold_to_id": "8ad0823f8040e52d0180433026b156fe",
- "default_payment_method": {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": "string",
- "property2": "string"
}, - "custom_objects": {
- "property1": {
- "next_page": "string",
- "data": [
- {
- "id": null,
- "updated_by_id": null,
- "updated_time": null,
- "created_by_id": null,
- "created_time": null,
- "custom_fields": { },
- "custom_objects": { },
- "type": null
}
]
}, - "property2": {
- "next_page": "string",
- "data": [
- {
- "id": null,
- "updated_by_id": null,
- "updated_time": null,
- "created_by_id": null,
- "created_time": null,
- "custom_fields": { },
- "custom_objects": { },
- "type": null
}
]
}
}, - "type": "paypal_express",
- "account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
- "account": { },
- "billing_details": {
- "name": "Amy Lawrence",
- "address": {
- "line1": "3333 Piedmont Rd NE",
- "line2": "Suite 1150",
- "city": "Atlanta",
- "country": "USA",
- "state": "GA",
- "postal_code": "30305"
}, - "email": "alawrence@gmail.com",
- "phone": "(888)976-9056"
}, - "maximum_payment_attempts": 6,
- "payment_retry_interval": 3,
- "device_session_id": "2cadffe03",
- "ip_address": "192.10.1.123",
- "bank_identification_number": "123456",
- "card": {
- "brand": "visa",
- "expiry_month": 10,
- "expiry_year": 2024,
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}, - "last_4": "2042"
}, - "paypal_express_native": {
- "baid": "string",
- "email": "string"
}, - "paypal_express": {
- "baid": "string",
- "email": "string"
}, - "paypal_adaptive": {
- "preapproval_key": "2G4EPFSD",
- "email": "alawrence@zuora.com"
}, - "sepa_debit": {
- "IBAN": "string",
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}, - "business_identification_code": "string"
}, - "cc_ref": {
- "second_token": "string",
- "token": "string",
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}
}, - "apple_pay": {
- "customer_token": "string",
- "id": "string",
- "last4": "string",
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}
}, - "ach_debit": {
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}, - "bank_aba_code": "string",
- "bank_account_name": "string",
- "bank_account_type": "business_saving",
- "bank_name": "string",
- "bank_account_number": "string"
}, - "betalings_debit": {
- "account_number": "string",
- "identity_number": "string",
- "bank_code": "string",
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}
}, - "autogiro_debit": {
- "account_number": "string",
- "identity_number": "string",
- "branch_code": "string",
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}
}, - "bacs_debit": {
- "account_number": "string",
- "bank_code": "string",
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}
}, - "au_becs_debit": {
- "account_number": "string",
- "branch_code": "string",
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}
}, - "nz_becs_debit": {
- "account_number": "string",
- "branch_code": "string",
- "bank_code": "string",
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}
}, - "pad_debit": {
- "account_number": "string",
- "branch_code": "string",
- "bank_code": "string",
- "mandate": {
- "id": "string",
- "reason": "string",
- "state": "active"
}
}, - "state": "active"
}, - "billing_documents": {
- "next_page": "string",
- "data": [
- {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": "string",
- "property2": "string"
}, - "custom_objects": {
- "property1": {
- "next_page": null,
- "data": [ ]
}, - "property2": {
- "next_page": null,
- "data": [ ]
}
}, - "account_id": "string",
- "description": "string",
- "due_date": "2023-01-01",
- "document_date": "2023-01-01",
- "reason_code": "string",
- "invoice_id": "string",
- "transfer_to_accounting": true,
- "exclude_from_auto_apply_rules": true,
- "pay": true,
- "type": "credit_memo",
- "billing_document_number": "string",
- "amount_refunded": 0,
- "state_transitions": {
- "posted_at": "string"
}, - "posted_by_id": "string",
- "state": "draft",
- "account": { },
- "items": {
- "next_page": "string",
- "data": [
- null
]
}, - "total": 0,
- "subtotal": 0,
- "tax": 0,
- "remaining_balance": 0,
- "amount_paid": 0,
- "paid": true,
- "past_due": true
}
]
}, - "payments": {
- "next_page": "string",
- "data": [
- {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": "string",
- "property2": "string"
}, - "custom_objects": {
- "property1": {
- "next_page": null,
- "data": [ ]
}, - "property2": {
- "next_page": null,
- "data": [ ]
}
}, - "description": "string",
- "reference_id": "string",
- "payment_number": "string",
- "account_id": "string",
- "amount": 0,
- "authorization_id": "string",
- "payment_date": "2019-08-24",
- "payment_method_id": "string",
- "gateway_id": "string",
- "gateway_order_id": "string",
- "second_reference_id": "string",
- "gateway_options": {
- "key": "value"
}, - "statement_descriptor": "string",
- "statement_descriptor_phone": "string",
- "external": true,
- "billing_documents": [
- {
- "id": null,
- "type": null,
- "amount": null,
- "items": [ ]
}
], - "currency": "string",
- "account": { },
- "amount_applied": 0,
- "remaining_balance": 0,
- "amount_refunded": 0,
- "state": "draft",
- "payout_id": "string",
- "gateway_response_code": "string",
- "payment_method": {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": null,
- "property2": null
}, - "custom_objects": {
- "property1": null,
- "property2": null
}, - "type": "paypal_express",
- "account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
- "account": { },
- "billing_details": {
- "name": null,
- "address": { },
- "email": null,
- "phone": null
}, - "maximum_payment_attempts": 6,
- "payment_retry_interval": 3,
- "device_session_id": "2cadffe03",
- "ip_address": "192.10.1.123",
- "bank_identification_number": "123456",
- "card": {
- "brand": null,
- "expiry_month": null,
- "expiry_year": null,
- "mandate": { },
- "last_4": null
}, - "paypal_express_native": {
- "baid": null,
- "email": null
}, - "paypal_express": {
- "baid": null,
- "email": null
}, - "paypal_adaptive": {
- "preapproval_key": null,
- "email": null
}, - "sepa_debit": {
- "IBAN": null,
- "mandate": { },
- "business_identification_code": null
}, - "cc_ref": {
- "second_token": null,
- "token": null,
- "mandate": { }
}, - "apple_pay": {
- "customer_token": null,
- "id": null,
- "last4": null,
- "mandate": { }
}, - "ach_debit": {
- "mandate": { },
- "bank_aba_code": null,
- "bank_account_name": null,
- "bank_account_type": null,
- "bank_name": null,
- "bank_account_number": null
}, - "betalings_debit": {
- "account_number": null,
- "identity_number": null,
- "bank_code": null,
- "mandate": { }
}, - "autogiro_debit": {
- "account_number": null,
- "identity_number": null,
- "branch_code": null,
- "mandate": { }
}, - "bacs_debit": {
- "account_number": null,
- "bank_code": null,
- "mandate": { }
}, - "au_becs_debit": {
- "account_number": null,
- "branch_code": null,
- "mandate": { }
}, - "nz_becs_debit": {
- "account_number": null,
- "branch_code": null,
- "bank_code": null,
- "mandate": { }
}, - "pad_debit": {
- "account_number": null,
- "branch_code": null,
- "bank_code": null,
- "mandate": { }
}, - "state": "active"
}, - "gateway_response": "string",
- "gateway_reconciliation_status": "string",
- "gateway_reconciliation_reason": "string",
- "gateway_state": "marked_for_submission",
- "state_transitions": {
- "canceled_time": "2019-08-24T14:15:22Z"
}, - "gateway_state_transitions": {
- "marked_for_submission_time": "2019-08-24T14:15:22Z",
- "settled_time": "2019-08-24T14:15:22Z",
- "submitted_time": "2019-08-24T14:15:22Z"
}
}
]
}, - "payment_methods": {
- "next_page": "string",
- "data": [
- {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": "string",
- "property2": "string"
}, - "custom_objects": {
- "property1": {
- "next_page": null,
- "data": [ ]
}, - "property2": {
- "next_page": null,
- "data": [ ]
}
}, - "type": "paypal_express",
- "account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
- "account": { },
- "billing_details": {
- "name": "Amy Lawrence",
- "address": {
- "line1": null,
- "line2": null,
- "city": null,
- "country": null,
- "state": null,
- "postal_code": null
}, - "email": "alawrence@gmail.com",
- "phone": "(888)976-9056"
}, - "maximum_payment_attempts": 6,
- "payment_retry_interval": 3,
- "device_session_id": "2cadffe03",
- "ip_address": "192.10.1.123",
- "bank_identification_number": "123456",
- "card": {
- "brand": "visa",
- "expiry_month": 10,
- "expiry_year": 2024,
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}, - "last_4": "2042"
}, - "paypal_express_native": {
- "baid": "string",
- "email": "string"
}, - "paypal_express": {
- "baid": "string",
- "email": "string"
}, - "paypal_adaptive": {
- "preapproval_key": "2G4EPFSD",
- "email": "alawrence@zuora.com"
}, - "sepa_debit": {
- "IBAN": "string",
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}, - "business_identification_code": "string"
}, - "cc_ref": {
- "second_token": "string",
- "token": "string",
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}
}, - "apple_pay": {
- "customer_token": "string",
- "id": "string",
- "last4": "string",
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}
}, - "ach_debit": {
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}, - "bank_aba_code": "string",
- "bank_account_name": "string",
- "bank_account_type": "business_saving",
- "bank_name": "string",
- "bank_account_number": "string"
}, - "betalings_debit": {
- "account_number": "string",
- "identity_number": "string",
- "bank_code": "string",
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}
}, - "autogiro_debit": {
- "account_number": "string",
- "identity_number": "string",
- "branch_code": "string",
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}
}, - "bacs_debit": {
- "account_number": "string",
- "bank_code": "string",
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}
}, - "au_becs_debit": {
- "account_number": "string",
- "branch_code": "string",
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}
}, - "nz_becs_debit": {
- "account_number": "string",
- "branch_code": "string",
- "bank_code": "string",
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}
}, - "pad_debit": {
- "account_number": "string",
- "branch_code": "string",
- "bank_code": "string",
- "mandate": {
- "id": null,
- "reason": null,
- "state": null
}
}, - "state": "active"
}
]
}, - "subscriptions": {
- "next_page": "string",
- "data": [
- {
- "id": "string",
- "updated_by_id": "string",
- "updated_time": "2019-08-24T14:15:22Z",
- "created_by_id": "string",
- "created_time": "2019-08-24T14:15:22Z",
- "custom_fields": {
- "property1": "string",
- "property2": "string"
}, - "custom_objects": {
- "property1": {
- "next_page": null,
- "data": [ ]
}, - "property2": {
- "next_page": null,
- "data": [ ]
}
}, - "subscription_number": "string",
- "state": "draft",
- "account_id": "string",
- "account": { },
- "invoice_owner_account_id": "string",
- "invoice_owner_account": { },
- "auto_renew": true,
- "latest_version": true,
- "initial_term": {
- "interval_count": 1,
- "interval": "day",
- "start_date": "2020-01-01",
- "type": "evergreen",
- "end_date": "2023-01-01"
}, - "current_term": {
- "interval_count": 1,
- "interval": "day",
- "start_date": "2020-01-01",
- "type": "evergreen",
- "end_date": "2023-01-01"
}, - "renewal_term": {
- "interval_count": 1,
- "interval": "day",
- "start_date": "2020-01-01",
- "type": "evergreen",
- "end_date": "2023-01-01"
}, - "start_date": "2020-01-01",
- "end_date": "2023-01-01",
- "description": "string",
- "contract_effective": "2023-01-01",
- "service_activation": "2023-01-01",
- "customer_acceptance": "2023-01-01",
- "invoice_separately": true,
- "version": 0,
- "order_number": "string",
- "subscription_plans": {
- "next_page": "string",
- "data": [
- null
]
}
}
]
}
}
]
}