SubscriptionInfo

subscription objectrequired

plan object

idPlanId (string)required

ID of subscription plan

Example: plan_monthly

titlestringrequired

descriptionstring

pricenumber<float>required

intervalSubscriptionInterval (string)required

Subscription billing interval

Possible values: [month, year]

featuresstring[]

badgestring

discountinteger<uint8>

savingsstring

Savings text (e.g., "save $14.96/search")

creditsinteger<uint32>

Number of credits/searches included in the plan

appleProductIdstring

App Store product id mapped to this plan

statusSubscriptionStatus (string)required

Subscription status

Possible values: [notexists, active, canceled, inactive]

nextstring<date-time>

Next billing date

expiresAtstring<date-time>

Subscription expiration date

urlstring

Stripe portal URL

activebooleanrequired

needShowbooleanrequired

isPromobooleanrequired

searchesLimitinteger<uint32>

Number of searches allowed in current subscription period

searchesUsedinteger<uint32>

Number of searches used in current subscription period

providerSubscriptionProvider (string)

Billing provider that owns the subscription; absent = stripe.

Possible values: [stripe, apple]

liveboolean

Raw stored billing status is active, trialing or past_due; absent = false.

portalUrlstring

SubscriptionInfo

{
  "subscription": {
    "plan": {
      "id": "plan_pro_monthly",
      "title": "Pro Monthly",
      "description": "Best for regular users",
      "price": 9.99,
      "interval": "month",
      "credits": 5,
      "features": [
        "5 searches per month",
        "Full profile access",
        "Priority support"
      ],
      "badge": "Popular"
    },
    "status": "notexists",
    "next": "2024-07-29T15:51:28.071Z",
    "expiresAt": "2024-07-29T15:51:28.071Z",
    "url": "string",
    "active": true,
    "needShow": true,
    "isPromo": true,
    "searchesLimit": 0,
    "searchesUsed": 0,
    "provider": "stripe",
    "live": true
  },
  "portalUrl": "string"
}