Provision customer

Creates a new customer and optionally provisions an initial subscription in a single operation.

POST /api/v1/customers

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const customerResponse = await client.v1.customers.provision({ id: 'id' });

console.log(customerResponse.data);

201

{
  "data": {
    "createdAt": "2026-04-17T16:57:41.989Z",
    "updatedAt": "2026-01-23T12:39:02.604Z",
    "archivedAt": null,
    "name": "John Doe",
    "email": "[e-mail]",
    "billingId": "cus_MIhJJFnJL24HFH",
    "id": "customer-6e24b4",
    "billingCurrency": null,
    "metadata": {},
    "integrations": [],
    "defaultPaymentMethod": {
      "type": "CARD",
      "billingId": "pm_1Q0PsIJvEtkwdCNYMSaVuRz6",
      "cardLast4Digits": "1234",
      "cardExpiryMonth": 12,
      "cardExpiryYear": 2025
    },
    "couponId": "coupon-6e24b4",
    "timezone": null,
    "passthrough": {
      "stripe": {
        "billingAddress": {
          "postalCode": "aiunt"
        },
        "paymentMethodId": "civitas caecus acer triduana coerceo tristis hic video aranea thema titulus corrumpo attero utor in demonstro porro comitatus velociter verumtamen arto fuga rem quod versus absorbeo dolores adfectus vobis magnam suffoco clarus video vesper ducimus ea spon",
        "taxIds": [
          {
            "type": "annus dolorum vulticulus caries aeternus tricesimus deinde turbo spes audeo adinventitias tribuo thymbra tabgo autem alius ultio optio nihil non maiores cervus paens atqui adduco antiquus calcar sortitus vereor cupiditas absum vespillo aliqua depopulo com",
            "value": "deripio comis thymum capitulus adversus cimentarius vulariter tempora curis theca odit assentator civis laudantium attonbitus comis velut claro reprehenderit sapiente aeger tenetur tam occaecati avarus benigne sponte veritas doloremque amet vociferor utro"
          }
        ],
        "invoiceCustomFields": {
          "defero vulariter animadverto bellicus cena adhaero truculenter cibo aestas ": "assum",
          "spoliatio fuga cogito cubo molestiae bardus utrimque iure decretum earum de": "eos decet cunctatio cruciamentum complectus acquiro crastinus ullam quo vid",
          "tenus decretum calamitas cometes deporto vinco maxime aequitas annus nisi ustulo somnus supellex sint suffoco suus cunctatio curo alter sto excepturi arca suscipio comptus admoveo cimentarius strenuus aequitas creptio defero officiis quidem ipsa vado error baiulus et curis ad comparo cogo maiores utpote nisi aedificium clarus soluta hic antepono thymum aranea numquam tantum sum solitudo suscipit strenuus adfectus similique casus subseco supellex peior artificiose abutor cuppedia defessus vicissitudo blandior cribro curo vomer stips abstergo provident cras vitiosus tero ambulo deorsum at uberrime omnis absens territo comminor cernuus agnosco corrumpo curriculum attonbitus odio debeo somniculosus natus conduco bibo tersus ademptio summopere consequatur eligendi umerus delectatio facere tergeo aliqua voco temporibus comes crapula cruentus eligendi addo ultio valens tristis consequuntur arx corrupti recusandae amita aestas ago adinventitias thymbra arma aestivus conforto blandior sperno ab": "tabes"
        }
      },
      "zuora": {
        "billingAddress": {
          "country": "viriliter comprehendo arguo vesco solus depromo altus suffoco curriculum ab",
          "line2": "certus dolores vilitas corrigo demulceo statim pel sursum non capto accedo turpis alias caput acies aggredior cavus paulatim defungo colo sophismata verus utique aestivus amaritudo terga tardus acervus audacia alveus delectatio vitae ancilla blanditiis cornu adhuc amiculum modi tutis valens carpo blanditiis bardus adaugeo volup pauci tener synagoga tamen cruentus admitto cribro decumbo carmen ter caste delego peccatus curo vaco virtus vindico coruscus summopere tenax color solvo acsi alter ullus facilis considero ventito terror approbo antea bis bonus calamitas tibi audacia commodi aer utique theca tremo abstergo veritas cultura dolorem approbo deripio viduo tolero quas appello crur comparo crastinus taceo stultus artificiose theca triumphus conventus benigne adulatio cibo vereor patior coniecto degenero cuius coaegresco aduro accusantium adficio capio dedecor ex atrocitas supplanto acsi ter tutis tabula una tero tego stips verecundia sub denuo cognomen dedecor tabula coaegresco repudi"
        }
      }
    }
  }
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Body

application/json

Provisions a new customer with unique ID, optional name and email.

id · string · required

Customer slug

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$

name · string | null

The name of the customer

Maximum string length: 255

email · string<email> | null

The email of the customer

Maximum string length: 255

billingId · string | null

The unique identifier for the entity in the billing provider

Maximum string length: 255

billingCurrency · enum<string> | null

The billing currency of the customer

Available options: usd, aed, all, amd, ang, aud, awg, azn, bam, bbd, bdt, bgn, bif, bmd, bnd, bsd, bwp, byn, bzd, brl, cad, cdf, chf, cny, czk, dkk, dop, dzd, egp, etb, eur, fjd, gbp, gel, gip, gmd, gyd, hkd, hrk, htg, idr, ils, inr, isk, jmd, jpy, kes, kgs, khr, kmf, krw, kyd, kzt, lbp, lkr, lrd, lsl, mad, mdl, mga, mkd, mmk, mnt, mop, mro, mvr, mwk, mxn, myr, mzn, nad, ngn, nok, npr, nzd, pgk, php, pkr, pln, qar, ron, rsd, rub, rwf, sar, sbd, scr, sek, sgd, sle, sll, sos, szl, thb, tjs, top, try, ttd, tzs, uah, uzs, vnd, vuv, wst, xaf, xcd, yer, zar, zmw, clp, djf, gnf, ugx, pyg, xof, xpf

metadata · object

Additional metadata

Show child attributes

integrations · CustomerIntegration · object[]

List of integrations

Show child attributes

defaultPaymentMethod · PaymentMethod · object

The default payment method details

Show child attributes

couponId · string enum<string>

Customer level coupon

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

timezone · string | null

Timezone to use for this customer

Maximum string length: 255

language · string | null

Language to use for this customer

Maximum string length: 255

passthrough · CustomerPassthrough · object

Vendor-specific billing passthrough fields.

Show child attributes

Response

201

application/json

The newly created customer object.

Response object

data · Customer · object · required

A customer can be either an organization or an individual

Show child attributes