High level billing overview for the 'Manage Subscription' page. Aggregates subscription snapshot, credit usage and basic billing meta data

get/v1/billing/overview

High level billing overview for the "Manage Subscription" page. Aggregates subscription snapshot, credit usage and basic billing meta data

Responses

200No description

Schema

Schema Structure

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "subscription": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "status": {
              "type": "string"
            },
            "current_period_start": {
              "type": "string"
            },
            "current_period_end": {
              "type": "string"
            },
            "trial_end": {
              "type": "string"
            },
            "cancel_at_period_end": {
              "type": "string"
            },
            "plan": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "slug": {
                  "type": "string"
                },
                "price": {
                  "type": "string"
                },
                "currency": {
                  "type": "string"
                },
                "interval": {
                  "type": "string"
                },
                "interval_count": {
                  "type": "string"
                },
                "credits_per_period": {
                  "type": "string"
                },
                "features": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name",
                "slug",
                "price",
                "currency",
                "interval",
                "interval_count",
                "credits_per_period",
                "features"
              ]
            }
          },
          "required": [
            "status",
            "current_period_start",
            "current_period_end",
            "trial_end",
            "cancel_at_period_end",
            "plan"
          ]
        },
        "credits": {
          "type": "object",
          "properties": {
            "available": {
              "type": "number"
            },
            "used_this_month": {
              "type": "number"
            },
            "included_in_plan": {
              "type": "string"
            },
            "purchased": {
              "type": "number"
            },
            "bonus": {
              "type": "number"
            },
            "expires_at": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "used_this_month",
            "included_in_plan",
            "purchased",
            "bonus",
            "expires_at"
          ]
        },
        "billing": {
          "type": "object",
          "properties": {
            "upcoming_invoice": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "amount": {
                  "type": "string"
                },
                "currency": {
                  "type": "string"
                },
                "period_start": {
                  "type": "string"
                },
                "period_end": {
                  "type": "string"
                }
              },
              "required": [
                "amount",
                "currency",
                "period_start",
                "period_end"
              ]
            },
            "recent_invoices": {
              "type": "array",
              "items": {}
            }
          },
          "required": [
            "upcoming_invoice",
            "recent_invoices"
          ]
        }
      },
      "required": [
        "subscription",
        "credits",
        "billing"
      ]
    }
  },
  "required": [
    "success",
    "data"
  ]
}