Update or create billing

PUT 
https://api.freemius.com/v1/products/{product_id}/users/{user_id}/billing.json

Auth:Bearer TokenSCOPE: PRODUCT

Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need.

1. Go to the Freemius Developer Dashboard.
2. Open the Settings page of the relevant product.
3. Click the API & Keys tab.
4. Copy the API Bearer Authorization Token from the UI.

---

Update or create the billing information for a user.

Request

Path Parameters

product_id integer<int64>required
The ID of the product.
Possible values: >= 1
Example: 1234
user_id integer<int64>required
The ID of the User.
Possible values: >= 1
Example: 1234

application/json

Bodyrequired

business_namestring
The name of the business.
Example: Freemius, Inc.
firststring
The first name used in the billing.
Example: John
laststring
The last name used in the billing.
Example: Doe
emailstring
The email used in the billing.
Example: [email protected]
phonestring
The phone number used in the billing.
Example: 555-555-5555
websitestring
The website used in the billing.
Example: https://freemius.com
tax_idstring
The business VAT number (EU or UK territories) or other tax ID (for example Sales Tax ID for the US).
Example: GB123456789
address_streetstring
The street address used in the billing.
Example: 21st Jump Street
address_aptstring
The street address 2 used in the billing.
Example: Block II
address_citystring
The city used in the billing.
Example: Atlanta
address_countrystring
The country used in the billing.
Example: United States
address_country_codestring
The ISO 3166-1 alpha 2 two-letter country code associated with the entity.
Example: us
address_statestring
The state of the location.
Example: New York
address_zipstring
ZIP or postal code.
Example: 00001

Responses

200

Billing information updated.

application/json

Schema

idstring<int64>

The unique identifier of the entity.

Possible values: >= 1

Example: 123456

createdstring<date-time>

The date and time the entity was created, under UTC timezone.

Example: 2025-01-01 00:00:00

updatedstring<date-time>nullable

The date and time the entity was updated, under UTC timezone. If null then the entity was never updated since its creation.

Example: 2025-01-01 00:00:00

business_namestring

The name of the business.

Example: Freemius, Inc.

firststring

The first name used in the billing.

Example: John

laststring

The last name used in the billing.

Example: Doe

emailstring

The email used in the billing.

Example: [email protected]

phonestring

The phone number used in the billing.

Example: 555-555-5555

websitestring

The website used in the billing.

Example: https://freemius.com

tax_idstring

The business VAT number (EU or UK territories) or other tax ID (for example Sales Tax ID for the US).

Example: GB123456789

address_streetstring

The street address used in the billing.

Example: 21st Jump Street

address_aptstring

The street address 2 used in the billing.

Example: Block II

address_citystring

The city used in the billing.

Example: Atlanta

address_countrystring

The country used in the billing.

Example: United States

address_country_codestring

The ISO 3166-1 alpha 2 two-letter country code associated with the entity.

Example: us

address_statestring

The state of the location.

Example: New York

address_zipstring

ZIP or postal code.

Example: 00001

401

Unauthorized access error. The request requires authentication but was not provided or the provided authentication does not satisfy the required permissions.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

Current timestamp.

Example: Thu, 11 May 2023 11:45:30 +0000

request object

This object sends back the request payload as received by the server (both from path and from body or query).

property name*any

This object sends back the request payload as received by the server (both from path and from body or query).

Example: {"beautify":true,"format":"json"}

402

The request is missing the specified argument.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

Current timestamp.

Example: Thu, 11 May 2023 11:45:30 +0000

request object

This object sends back the request payload as received by the server (both from path and from body or query).

property name*any

This object sends back the request payload as received by the server (both from path and from body or query).

Example: {"beautify":true,"format":"json"}

404

The requested resource was not found.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

Current timestamp.

Example: Thu, 11 May 2023 11:45:30 +0000

request object

This object sends back the request payload as received by the server (both from path and from body or query).

property name*any

This object sends back the request payload as received by the server (both from path and from body or query).

Example: {"beautify":true,"format":"json"}