Schema

Account

The Account object of the Printags API.

Fields

  • idstring
  • displaynamestring
  • emailstring (email)
  • phonestring
  • balancenumber (float)
  • minimal_balancenumber
  • minimal_creditnumber
  • fiscal_numberstring
  • subscription_planSubscriptionPlan
  • optionsobject
  • options.langstring
  • options.paymentsobject
  • options.payments.groupWithSubscriptionboolean
  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • subscription_plan_sourcestring: stripe, manual, shopify, woocommerce
    Who bills the account's plan: stripe (a Printags subscription paid by card), manual (given by the Printags team), shopify or woocommerce (billed by the platform; Stripe Checkout then answers 409 PLAN_BILLED_BY_PLATFORM). Absent when the account has no plan, or for an older plan whose source is not recorded yet (resolved at its next subscription change). It cannot be changed through the API.
Example
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "displayname": "John Doe",
  "email": "[email protected]",
  "phone": "+1234567890",
  "balance": 100.5,
  "minimal_balance": 0,
  "minimal_credit": 0,
  "fiscal_number": "FR12345678901",
  "subscription_plan": {
    "id": "987e6543-e21a-11d4-a789-0242ac120002",
    "displayname": "Basic Plan",
    "price": 49.99,
    "shippingLetter": true,
    "whiteLabel": false
  },
  "options": {
    "lang": "EN",
    "payments": {
      "groupWithSubscription": false
    }
  },
  "createdAt": "2024-01-01T10:00:00.000Z",
  "updatedAt": "2024-11-01T12:00:00.000Z",
  "subscription_plan_source": "stripe"
}