Sign up customer - Unprice Documentation

Use customers.signUp to create a customer and provision their subscription, entitlements, billing periods, and wallet from a published plan version.

// Subscribe to the latest published version of the Pro plan.
const { result, error } = await unprice.customers.signUp({
  name: "Acme Inc.",
  email: "buyer@example.com",
  planSlug: "pro",
  externalId: "acct_123",
  successUrl: "https://example.com/dashboard",
  cancelUrl: "https://example.com/login"
});

if (error) {
  // handle potential network or bad request error
  // a link to our docs will be in the `error.docs` field
  console.error(error.message);
  return;
}

console.log(result);

{
  "success": true,
  "url": "https://example.com/dashboard",
  "customerId": "cus_1234567890"
}

Request

string

required

The name of the customer

string

required

The email of the customer

string

The timezone of the customer. If not provided, the system will use the project timezone

string

The default currency of the customer. If not provided, the system will use the project currency. Must be one of: “USD” or “EUR”

string

The billing interval for the customer’s subscription. If plan version is provided, this will match the plan version. If plan slug is provided, this will be the default billing interval of the plan. Must be one of: “month”, “year”, “day”, “minute”, or “onetime”

string

The plan slug to sign up for. If provided, Unprice uses the latest published version for that slug. Required if planVersionId is not provided

string

The specific plan version ID to sign up for. Required if planSlug is not provided

array

Configuration for subscription items. Required for quantity-based features when customer needs to set them. Leave empty to use plan defaults

string

required

The feature plan ID of the item

string

required

The feature slug of the item

boolean

Whether the item is a usage-based feature

number

The number of units the customer is subscribed to

number

The minimum number of units for the feature

number

The maximum number of units for the feature

string

Usage credit policy for the initial subscription phase. Use “uncapped” for postpaid usage, or “capped” to require a finite usage allowance.

number

Optional capped usage credit amount in the currency’s smallest unit, such as cents for USD/EUR. For example, pass 10000 for a 100.00 allowance.

string

An external ID to associate with the customer, such as an account ID from your database

string

required

The URL to redirect to after successful signup (typically your dashboard)

string

required

The URL to redirect to if the customer cancels signup (typically your login page)

Response

boolean

required

Whether the signup was successful

string

required

The URL to redirect the customer to (either success or cancel URL)

string

required

The Unprice customer ID generated for this customer

​Request

​Response

Request

Response