Register Billing Method
This request registers a billing method to a specific partner.
post | /partners/{partner_sid}/billing_method |
Sample
A sample POST request to register a billing method for the partner:
curl -X POST \
'https://api.carrierx.com/core/v2/partners/ed437757-002d-4ecc-aa5a-efdf5e50dba0/billing_method' \
-H 'Content-Type: application/json' \
--data-binary '{"type":"visa", "cc_number":"4012888818888", "cc_expiration":"022019", "cc_cid":"318", "first_name":"John", "last_name":"Smith", "address1":"4300 E Pacific Coast Hwy", "address2":"Suite 1", "city":"Los Angeles", "state":"CA", "zip":"90804", "country_code":"USA", "phone":"15162065574"}' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
Response
200
status code with a serialized copy of the 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"
}
note
Note that the cc_number
value will be redacted as the last four integers in the response.
Required Scopes
To register a billing method the partner must have one of the following scopes enabled:
partners.billing_method.manage
partners.billing_method.create
Path Arguments
Parameter | Data Type | Description |
---|---|---|
partner_sid required | string | The partner secure ID. |
Body Arguments
JSON representation of the fields and values of the Billing Method object to be created.
Required fields to create a billing method are:
address1
(forcheck
,electronic_check
, andwire
billing methods)cc_cid
(for credit card billing methods)cc_expiration
(for credit card billing methods)cc_number
(for credit card billing methods)city
(forcheck
,electronic_check
, andwire
billing methods)country_code
first_name
last_name
phone
type
zip
Refer to this table to view all fields that appear in the Billing Method object.