Billing Method Object
The Billing Method object defines how a partner pays for services within the CarrierX platform. It contains all information required to process financial transactions, including payment type, payer details, and billing address.
Each billing method record is associated with a partner account and identifies the specific mechanism used for payment — such as credit card, electronic check, or wire transfer. Depending on the method type, certain fields (for example, cc_number or ec_account_number) are used while others remain empty.
A billing method typically includes:
- Payment details — credit card or electronic check credentials required for processing payments.
- Billing address information — full customer address, including city, state, country code, and ZIP/postal code.
- Contact information — the payer's first and last name, and phone number for verification and communication.
- Payment type — the financial instrument used for billing (e.g.,
visa,master_card,electronic_check, orwire).
This object enables CarrierX to securely store and validate payment credentials, ensuring proper invoicing and automated service continuity for each partner.
Billing Method Object Attributes
| Attribute | Data Type | Description |
|---|---|---|
| address1 | string | The customer address. |
| address2 | string | The customer address second field. |
| cc_cid | string | The credit card CID. This field is hidden in the serialized copy of the Billing Method objects received in responses to the requests for the security reasons. |
| cc_expiration | string | The credit card expiration date in the |
| cc_number | string | The credit card number. |
| city | string | The customer city. |
| country_code | string | The partner country code. |
| ec_account_number | string | The electronic check account number. |
| ec_routing_number | string | The electronic check routing number. |
| first_name | string | The partner first name. |
| last_name | string | The partner last name. |
| phone | string | The partner phone number. |
| state | string | The customer state in a two-letter abbreviation format. |
| type | string | The type of the billing method. Values accepted in this field are:
|
| state | string | The customer state in a two-letter abbreviation format. |
| zip | string | The customer zip code. |
Sample Billing Method Object
{
"address1":"4300 E Pacific Coast Hwy",
"address2":"Suite 1",
"cc_expiration":"022019",
"cc_number":"8888",
"city":"Long Beach",
"country_code":"USA",
"first_name":"John",
"last_name":"Smith",
"phone":"15162065574",
"state":"CA",
"type":"visa",
"zip": "90804"
}