Skip to main content
POST
/
v1
/
subscriptions
/
customers
JavaScript
import Hercules from '@usehercules/sdk';

const client = new Hercules({
  apiVersion: '2025-12-09',
  apiKey: process.env['HERCULES_API_KEY'], // This is the default and can be omitted
});

const customer = await client.beta.subscriptions.customers.create();

console.log(customer.id);
{
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "stripe_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as: Bearer

Body

application/json

Request to create a new customer. Hercules recommends creating a customer immediately after creating the corresponding entity in your app.

​
name
string

The customer's full name

​
email
string<email>

The customer's email address for receipts and notifications

​
phone
string

The customer's phone number

​
address
object

The customer's billing address

Response

201 - application/json

The created customer object

A billable customer. Represents the entity in your app that will be charged—typically a user, organization, or project.

​
id
string
required

Unique identifier for the entitlement

​
created
string<date-time>
required

Timestamp when the customer was created

​
name
string | null

The customer's full name

​
email
string | null

The customer's email address for receipts and notifications

​
phone
string | null

The customer's phone number

​
address
object

The customer's billing address

​
stripe_id
string | null

Internal payment provider reference