Billing: CRUD Credit Card Information

The following endpoints can be used to maintain credit card information for a tenant.

Create credit card information

You can use the following endpoint within your custom pages in order to create credit card information for a tenant.

Summary

  • Endpoint: /api/v2/billing_update_cc
  • Method: POST
  • Required User Type: TA

Body Parameters

  • token - Stripe token generated from credit card information
  • email - (optional) Email address to update Stripe customer information
    • This is recommended so that you can edit credit card information for a user while logged in as a Super Admin. Otherwise, Stripe will try to modify credit card information for Super Admin login instead of for the user.

Response

A successful response will be a text message "Success"

Example

Request body

{
token:"XXXXXXXXXXXX"
}

Response Data

"Success"

 

Retrieve credit card information

Refer to Retrieve subscription > Response > account info > card

Update credit card information

You can use the following endpoint within your custom pages in order to update credit card information for a tenant.

Summary

  • Endpoint: /api/v2/billing_update_cc
  • Method: POST
  • Required User Type: TA

Body Parameters

  • token - Stripe token generated from credit card information

Response

A successful response will be a text message "Success"

Example

Request body

{
token:"XXXXXXXXXXXX"
}

Response Data

"Success"

 

Delete credit card information

In order to delete credit card information, the tenant must unsubscribe.