Skip to content

API reference

Billing

Read the plan, the card and the invoices, move to another plan, cancel or keep it, and open the billing portal. Everything the Plan and billing page does, for keys with admin access.

Read billing

GEThttps://formpik.com/api/v1/billing

The plan and subscription, the card on file, the latest invoices, and every plan with its monthly price in cents and its limits.

200 OK
{
  "data": {
    "plan": "pro",
    "payments_enabled": true,
    "subscription": { "status": "active", "cancel_at_period_end": false, "current_period_end": "2026-12-02T08:12:44.000Z" },
    "payment_method": { "brand": "visa", "last4": "4242" },
    "invoices": [
      { "id": "in_1Q2w3E4r", "number": "NW-0003", "status": "paid", "amount_cents": 2999, "currency": "usd", "created_at": "2026-11-02T08:12:44.000Z", "hosted_url": "https://invoice.stripe.com/...", "pdf_url": "https://pay.stripe.com/..." }
    ],
    "plans": [
      { "id": "starter", "name": "Starter", "price_cents": 0, "limits": { "...": "..." } },
      { "id": "pro", "name": "Pro", "price_cents": 2999, "limits": { "...": "..." } },
      { "id": "max", "name": "Max", "price_cents": 9999, "limits": { "...": "..." } }
    ]
  }
}

Change the plan

POSThttps://formpik.com/api/v1/billing/checkout

Send { "plan": "pro" } or max.

  • Without a paid plan, the answer is { "data": { "checkout_url": "https://checkout.stripe.com/...", "changed": false } }. A person opens the link to pay, and the plan changes once they have.
  • With a paid plan, it changes at once and answers { "data": { "changed": true, "plan": "max" } }. An upgrade charges the prorated difference straight away and changes nothing when the card fails; a downgrade leaves a credit for the next invoice.
  • Moving down to Starter is cancelling, below. Going down a plan never deletes anything: existing forms and flows keep working, only adding more is blocked.

Cancel or keep the plan

PATCHhttps://formpik.com/api/v1/billing/subscription

Send { "cancel_at_period_end": true } to end the paid plan when the period already paid for ends, or false to keep it. Nothing is refunded and nothing is deleted.

Open the billing portal

POSThttps://formpik.com/api/v1/billing/portal

Answers portal_url, a Stripe page where a person changes the card or the billing details and downloads invoices. Answers 409 with no-customer before the first upgrade.