POST
/
api
/
v1
/
customers
Create Customer
curl --request POST \
  --url https://app.flowglad.com/api/v1/customers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer": {
    "email": "<string>",
    "name": "<string>",
    "archived": true,
    "logoURL": "<string>",
    "iconURL": "<string>",
    "domain": "<string>",
    "externalId": "<string>",
    "userId": "<string>",
    "pricingModelId": "<string>"
  }
}'
{
  "data": {
    "customer": {
      "id": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdByCommit": "<string>",
      "updatedByCommit": "<string>",
      "livemode": true,
      "organizationId": "<string>",
      "email": "<string>",
      "name": "<string>",
      "invoiceNumberBase": "<string>",
      "archived": true,
      "logoURL": "<string>",
      "iconURL": "<string>",
      "domain": "<string>",
      "billingAddress": {
        "name": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "jsmith@example.com",
        "address": {
          "name": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "phone": "<string>"
      },
      "externalId": "<string>",
      "userId": "<string>",
      "pricingModelId": "<string>"
    },
    "subscription": {
      "id": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdByCommit": "<string>",
      "updatedByCommit": "<string>",
      "livemode": true,
      "startDate": "<string>",
      "customerId": "<string>",
      "organizationId": "<string>",
      "status": "trialing",
      "defaultPaymentMethodId": "<string>",
      "backupPaymentMethodId": "<string>",
      "trialEnd": "<string>",
      "currentBillingPeriodStart": "<string>",
      "currentBillingPeriodEnd": "<string>",
      "metadata": {},
      "canceledAt": "<string>",
      "cancelScheduledAt": "<string>",
      "cancellationReason": "<string>",
      "replacedBySubscriptionId": "<string>",
      "isFreePlan": true,
      "priceId": "<string>",
      "runBillingAtPeriodStart": true,
      "interval": "day",
      "intervalCount": "<any>",
      "billingCycleAnchorDate": "<string>",
      "name": "<string>",
      "renews": true,
      "current": true
    },
    "subscriptionItems": [
      {
        "id": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "createdByCommit": "<string>",
        "updatedByCommit": "<string>",
        "livemode": true,
        "subscriptionId": "<string>",
        "name": "<string>",
        "addedDate": "<string>",
        "priceId": "<string>",
        "unitPrice": "<any>",
        "quantity": "<any>",
        "usageEventsPerUnit": null,
        "usageMeterId": null,
        "metadata": {},
        "type": "<string>",
        "externalId": "<string>",
        "expiredAt": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Body

application/json
customer
object
required

Response

Successful response

data
object
required