Home
DocumentationTutorialsTry Cloud

Settings

The "Setting" section offers features for users to update their billing address and manage tax identification (tax ID) information. Users can modify their billing details as well as add or remove tax IDs, providing flexibility and control over their financial and tax-related information within the platform.

Get billing settings

GET {{BASE_URL}}/api/billing-settings

Get the billing settings for the team that the customer is a member of.

Headers

Name
Type
Description

Authorization*

String

Bearer Token

{
    "_id": "6548e2660919dc0442dc2ec7",
    "user": "6548a41138406c14db33b606",
    "address1": "Test",
    "address2": "test",
    "city": "Test",
    "company": "Rezet",
    "country": "Afghanistan",
    "createdAt": "2023-11-06T12:56:06.296Z",
    "state": "Test",
    "taxId": null,
    "updatedAt": "2023-11-06T12:56:12.057Z",
    "zip": "34334"
}

Update billing settings

PUT {{BASE_URL}}/api/billing-settings

Update the billing settings for the team that the customer is a member of.

Headers

Name
Type
Description

Authorization*

String

Bearer Token

Request Body

Name
Type
Description

address1

String

address2

String

city

String

company

String

country

String

state

String

zip

String

{
    "_id": "6548e2660919dc0442dc2ec7",
    "user": "6548a41138406c14db33b606",
    "address1": "test1",
    "address2": "Test",
    "city": "Test",
    "company": "Rezet",
    "country": "Afghanistan",
    "createdAt": "2023-11-06T12:56:06.296Z",
    "state": "Test",
    "taxId": null,
    "updatedAt": "2023-11-06T13:02:08.440Z",
    "zip": "34334"
}

Create taxID

POST {{BASE_URL}}/api/teams/{id}/tax_ids

Displaying a customer’s tax ID on invoice documents is a common requirement that you can satisfy by adding tax IDs to customers.

Path Parameters

Name
Type
Description

*

String

team id

Headers

Name
Type
Description

Authorization*

String

Bearer Token

Request Body

Name
Type
Description

value*

String

type*

String

{
    "taxId": {
        "value": "A-123456-Z",
        "stripeId": "txi_1O9SVtA0ZUrt0vQJbIeZgLFJ",
        "status": 0
    }
}

Delete taxID

DELETE {{BASE_URL}}/api/teams/{teamId}/tax_ids/{taxId}

Deletes an existing tax_id object.

Headers

Name
Type
Description

Authorization*

String

Bearer Token

{
    "status": "ok"
}

Last updated