Skip to content

List your YoPrint invoices

Open .md

GET/v1/api/store/{team_slug}/setting/subscription/invoice

v1Operation ID v1_public_setting_subscription_invoice_index

Returns the invoices YoPrint has billed your team for its subscription, newest first, a page at a time (the team's page size, 50 by default). These are YoPrint's invoices to you, not invoices to your customers.

Permission

The team owner, or a member with the Manage Billing permission. Manage Settings alone is not enough.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

  • dataarray of objectsrequired
    Fields of each item (7)
    • currencystring | nullrequired
    • idstringrequired
    • pdf_urlstring (uri)required

      A short-lived link to the PDF. It carries a download token: treat it as private.

    • taxinteger | numberrequired

      Tax. Thousandths, an older encoding: 5000 is 5.00. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

    • totalinteger | numberrequired

      The invoice total. Thousandths, an older encoding: 69000 is 69.00. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

    • created_atstring (date-time) | null
    • provider_created_atstring (date-time) | null

      When Stripe created it.

  • statusintegerrequired
  • successbooleanrequired
  • Child fields (6)
    • countintegerrequired
    • currentPageintegerrequired
    • perPageintegerrequired
    • totalintegerrequired
    • totalPagesintegerrequired

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

    When
    You are not the owner and your role lacks Manage Billing. The body is {"message": "Insufficient Permission"}, without the error envelope.
    Fix
    Use the owner's key, or that of a member with Manage Billing.
  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

  • Part of your YoPrint subscription: what your shop pays YoPrint, not your customers' payments.
  • AI apps (MCP connections) can't call this operation: they get 403 agent_operation_not_available. Use a personal API key.