Headers

• X-Gatego-oid

  Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Query parameters

• billableOrganizationId integer(int64)

  Organization Id. or Organization Group Id. If not present, and the logged user is a ORG_GROUP_ADMIN then his managed organizationGroupId will be used, otherwise the current logged account's standard organizationId will be used. Only an ADMIN can query freely any organizationId or organizationGroupId

• last_months integer(int32)

  Number of previous months to include movements from. Current month is always included so if the value is '1', then current and previous months will be considered. If zero only the movements of current month are retrieved. This is the default value.

• invoices_limit integer(int32)

  Maximum number of invoices returned. Unlimited by default

Responses

• 200 */*

  OK

  Hide response attributes Show response attributes object

  • account_status string

    Values are ACTIVE, INITIAL_PAYMENT_FAILED, NO_SUBSCRIPTION, TRIALING, UNKNOWN, or UNPAID.

  • invoices array[object]
    Hide invoices attributes Show invoices attributes object

    • amount_due integer(int64)
    • amount_paid integer(int64)
    • amount_remaining integer(int64)
    • application_fee_amount integer(int64)
    • attempt_count integer(int64)
    • attempted boolean
    • currency string
    • description string
    • due_date string(date-time)
    • finalized_at string(date-time)
    • id string
    • invoice_number string
    • marked_uncollectible_at string(date-time)
    • next_payment_attempt string(date-time)
    • paid boolean
    • paid_at string(date-time)
    • pdf_url string
    • period_end string(date-time)
    • period_start string(date-time)
    • status string
    • voided_at string(date-time)
  • movement_counts array[object]
    Hide movement_counts attributes Show movement_counts attributes object

    • count integer(int64)
    • invoice_id string
    • period_end string(date-time)
    • period_start string(date-time)
  • payment_method object
    Hide payment_method attributes Show payment_method attributes object

    • card object
      Hide card attributes Show card attributes object

      • brand string
      • country string
      • created integer(int64)
      • exp_month integer(int32)
      • exp_year integer(int32)
      • last4 string
    • email string
    • id string
  • subscription object
    Hide subscription attributes Show subscription attributes object

    • active boolean
    • aggregate_usage string
    • amount integer(int64)
    • created string(date-time)
    • currency string
    • current_period_end string(date-time)
    • current_period_start string(date-time)
    • days_until_due integer(int32)
    • id string
    • price_id string
    • status string
    • tiers_mode string
    • trial_end string(date-time)
    • trial_period_days integer(int64)
    • trial_start string(date-time)
  • upcoming_invoice object
    Hide upcoming_invoice attributes Show upcoming_invoice attributes object

    • amount_due integer(int64)
    • amount_paid integer(int64)
    • amount_remaining integer(int64)
    • application_fee_amount integer(int64)
    • attempt_count integer(int64)
    • attempted boolean
    • currency string
    • description string
    • due_date string(date-time)
    • finalized_at string(date-time)
    • id string
    • invoice_number string
    • marked_uncollectible_at string(date-time)
    • next_payment_attempt string(date-time)
    • paid boolean
    • paid_at string(date-time)
    • pdf_url string
    • period_end string(date-time)
    • period_start string(date-time)
    • status string
    • voided_at string(date-time)
• 401

  Unauthorized

• 403

  Forbidden

• 404

  Not Found