Endpoints associated with creating and managing user accounts.
Endpoints associated with creating and managing user accounts.
Get account information
Refer to Status Codes for definitions of HTTP status code responses.
curl --include \
--header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA==" \
'https://rest.clicksend.com/v3/account'{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "Here's your account.", "data": { "user_id": 116, "username": "johndoe1", "user_email": "johndoe1@awesome.com", "active": 0, "banned": 0, "balance": "4.998000", "user_phone": "+15184811001", "reply_to": "originalemail", "delivery_to": null, "user_first_name": "John", "user_last_name": "Doe", "account": 0, "account_name": "The Awesome Company", "account_billing_email": "johndoe1@awesome.com", "account_billing_mobile": "+15184811001", "country": "US", "default_country_sms": "US", "auto_recharge": 0, "auto_recharge_amount": "20.00", "low_credit_amount": "0.00", "setting_unicode_sms": 0, "setting_email_sms_subject": 0, "setting_fix_sender_id": 0, "setting_sms_message_char_limit": 6, "old_dashboard": 0, "balance_commission": 0.299954, "timezone": "Australia/Melbourne", "_currency": { … }, "_subaccount": { … } } }
Get account usage
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| year | string | true | none | Your account usage year. Example: 2019 |
| month | string | true | none | Your account usage month. Example: 4 |
Refer to Status Codes for definitions of HTTP status code responses.
curl -i -X GET \
-u <username>:<password> \
'https://rest.clicksend.com/v3/account/usage/{year}/{month}/subaccount' \
-H 'Content-Type: application/json'{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "Here is your usage for this month.", "data": { "sms": [ … ], "voice": [ … ], "fax": [ … ], "post": [ … ], "email": [ … ], "sms_total": { … }, "voice_total": { … }, "fax_total": { … }, "post_total": { … }, "email_total": { … } } }