Headers

• organization string Required

  id of the selected (active) organization

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • data object Required
    Hide data attributes Show data attributes object

    • data array[object] Required
      Hide data attributes Show data attributes object

      • id string Required
      • active boolean Required
      • attributes array[string] Required
      • created number Required
      • default_price object Required
        Hide default_price attributes Show default_price attributes object

        • id string Required
        • active boolean Required
        • billing_scheme string Required
        • created number Required
        • currency string Required
        • custom_unit_amount object | null Required
        • livemode boolean Required
        • lookup_key string Required
        • metadata object Required
        • type string Required
        • unit_amount number Required
        • unit_amount_decimal string Required
      • features array[object] Required
        Hide features attribute Show features attribute object

        • name string
      • livemode boolean Required
      • metadata object Required
      • name string Required
      • tax_code object | null Required
      • unit_label object | null Required
      • url object | null Required
      • isPayAsYouGo boolean Required
      • isCurrentPlan boolean Required
    • attachedPaymentMethod object Required

      Attached payment method

    • upcomingInvoice object Required

      Attached payment method

      Hide upcomingInvoice attributes Show upcomingInvoice attributes object

      • account_country string Required
      • account_name string Required
      • amount_due number Required
      • amount_paid number Required
      • amount_remaining number Required
      • attempted boolean Required
      • billing_reason string Required
      • collection_method string Required
      • created number Required
      • currency string Required
      • customer_address object | null Required
      • customer_email string Required
      • customer_name string Required
      • customer_phone string | null Required
      • description string | null Required
      • discount object | null Required
      • discounts array[string] Required
      • due_date object | null Required
      • livemode boolean Required
      • period_end number Required
      • period_start number Required
      • status string Required
      • subtotal number Required
      • subtotal_excluding_tax number Required
      • tax number Required
      • total number Required
      • total_discount_amounts array[object] Required
      • total_excluding_tax number Required
      • total_tax_amounts array[object] Required
      • lines array[object] Required
        Hide lines attributes Show lines attributes object

        • id string Required
        • amount number Required
        • amount_excluding_tax number Required
        • currency string Required
        • description string Required
        • discount_amounts array[object] Required
        • discountable boolean Required
        • discounts array[string] Required
        • livemode boolean Required
        • metadata object Required
        • period object Required
        • product_lookup_description string Required
        • plan object Required
          Hide plan attributes Show plan attributes object

          • id string Required
          • active boolean Required
          • attributes array[string] Required
          • created number Required
          • default_price object Required
            Hide default_price attributes Show default_price attributes object

            • id string Required
            • active boolean Required
            • billing_scheme string Required
            • created number Required
            • currency string Required
            • custom_unit_amount object | null Required
            • livemode boolean Required
            • lookup_key string Required
            • metadata object Required
            • type string Required
            • unit_amount number Required
            • unit_amount_decimal string Required
          • features array[object] Required
            Hide features attribute Show features attribute object

            • name string
          • livemode boolean Required
          • metadata object Required
          • name string Required
          • tax_code object | null Required
          • unit_label object | null Required
          • url object | null Required
          • isPayAsYouGo boolean Required
          • isCurrentPlan boolean Required
        • price object Required
          Hide price attributes Show price attributes object

          • id string Required
          • active boolean Required
          • billing_scheme string Required
          • created number Required
          • currency string Required
          • custom_unit_amount object | null Required
          • livemode boolean Required
          • lookup_key string Required
          • metadata object Required
          • type string Required
          • unit_amount number Required
          • unit_amount_decimal string Required
        • quantity number Required
        • unit_amount_excluding_tax number Required
    • currentPlan object Required
      Hide currentPlan attributes Show currentPlan attributes object

      • id string Required
      • active boolean Required
      • attributes array[string] Required
      • created number Required
      • default_price object Required
        Hide default_price attributes Show default_price attributes object

        • id string Required
        • active boolean Required
        • billing_scheme string Required
        • created number Required
        • currency string Required
        • custom_unit_amount object | null Required
        • livemode boolean Required
        • lookup_key string Required
        • metadata object Required
        • type string Required
        • unit_amount number Required
        • unit_amount_decimal string Required
      • features array[object] Required
        Hide features attribute Show features attribute object

        • name string
      • livemode boolean Required
      • metadata object Required
      • name string Required
      • tax_code object | null Required
      • unit_label object | null Required
      • url object | null Required
      • isPayAsYouGo boolean Required
      • isCurrentPlan boolean Required
    • billingAlert object Required

      Dunning banner state; null when billing is healthy

      Hide billingAlert attributes Show billingAlert attributes object

      • pastDue boolean Required

        Subscription is past due (in dunning)

      • graceUntil string(date-time) | null Required

        End of the grace window while past due

      • blocked boolean Required

        Access is blocked (grace expired, or subscription unpaid/canceled)

  • statusCode number Required
  • timestamp string(date-time) Required