StoreBillingStatusDto

alertsStoreAlertDto[]Required

idFlakeIdRequired

admin_visiblebooleanRequired

created_atstringRequired

metadataobjectRequired

statusenumRequired

Possible enum values

info
warning
action_required
resolved

store_idFlakeIdRequired

store_visiblebooleanRequired

typeenumRequired

Possible enum values

other
excessive_chargeback_rate
kyc_required
business_details_required
increased_fraud_rate
unsupported_product
product_compliance_check
integration_issue
storefront_compliance
support_inquiry
feature_eligibility
feature_enrolled

action_linkstringOptional

action_required_atstringOptional

custom_messagestringOptional

custom_titlestringOptional

entity_idFlakeIdOptional

expires_atstringOptional

resolved_atstringOptional

resolved_byFlakeIdOptional

updated_atstringOptional

feature_flagsstring[]Required

is_lockedbooleanRequired

no_billing_detailsbooleanRequired

planPlanDtoRequired

idstringRequired

is_custombooleanRequired

namestringRequired

descriptionstringOptional

plan_limitsobjectRequired

plan_pricingPlanPricingDtoRequired

idFlakeIdRequired

begins_atstringRequired

plan_idstringRequired

platform_fee_rateintegerRequired

subscription_price_monthlyintegerRequired

ends_atstringOptional

subscription_price_annuallyintegerOptional

revenue_usageintegerRequired

store_idFlakeIdRequired

lock_reasonstringOptional

payment_methodSubscriptionPaymentMethodDtoOptional

Represents the payment method a store's subscription is billed to.

idstringRequired

The identifier of the payment method within the payment gateway.

typestringRequired

The kind of payment method, such as a card.

card_brandstringOptional

The card network, when the payment method is a card.

card_exp_monthintegerOptional

The month the card expires, when the payment method is a card.

card_exp_yearintegerOptional

The year the card expires, when the payment method is a card.

card_last4stringOptional

The last four digits of the card, when the payment method is a card.

subscriptionStoreSubscriptionDtoOptional

idFlakeIdRequired

cancel_at_period_endbooleanRequired

created_atstringRequired

currencystringRequired

current_period_endstringRequired

current_period_startstringRequired

gatewaystringRequired

gateway_checkout_idstringRequired

gateway_payment_method_idstringRequired

gateway_subscription_idstringRequired

plan_idstringRequired

statusenumRequired

Possible enum values

incomplete
trialing
active
requires_action
canceled

store_idFlakeIdRequired

cancel_atstringOptional

downgrade_period_end_plan_idstringOptional

ended_atstringOptional

updated_atstringOptional

Example

{
  "alerts": [
    {
      "id": "411486491630370816",
      "admin_visible": true,
      "created_at": "2024-01-01T00:00:00Z",
      "metadata": {},
      "status": "info",
      "store_id": "411486491630370816",
      "store_visible": true,
      "type": "other",
      "action_link": "string",
      "action_required_at": "2024-01-01T00:00:00Z",
      "custom_message": "string",
      "custom_title": "string",
      "entity_id": "411486491630370816",
      "expires_at": "2024-01-01T00:00:00Z",
      "resolved_at": "2024-01-01T00:00:00Z",
      "resolved_by": "411486491630370816",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "feature_flags": [
    "string"
  ],
  "is_locked": true,
  "no_billing_details": true,
  "plan": {
    "id": "string",
    "is_custom": true,
    "name": "string",
    "description": "string"
  },
  "plan_limits": {},
  "plan_pricing": {
    "id": "411486491630370816",
    "begins_at": "2024-01-01T00:00:00Z",
    "plan_id": "string",
    "platform_fee_rate": 0,
    "subscription_price_monthly": 0,
    "ends_at": "2024-01-01T00:00:00Z",
    "subscription_price_annually": 0
  },
  "revenue_usage": 0,
  "store_id": "411486491630370816",
  "lock_reason": "string",
  "payment_method": {
    "id": "string",
    "type": "string",
    "card_brand": "string",
    "card_exp_month": 0,
    "card_exp_year": 0,
    "card_last4": "string"
  },
  "subscription": {
    "id": "411486491630370816",
    "cancel_at_period_end": true,
    "created_at": "2024-01-01T00:00:00Z",
    "currency": "string",
    "current_period_end": "2024-01-01T00:00:00Z",
    "current_period_start": "2024-01-01T00:00:00Z",
    "gateway": "string",
    "gateway_checkout_id": "string",
    "gateway_payment_method_id": "string",
    "gateway_subscription_id": "string",
    "plan_id": "string",
    "status": "incomplete",
    "store_id": "411486491630370816",
    "cancel_at": "2024-01-01T00:00:00Z",
    "downgrade_period_end_plan_id": "string",
    "ended_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}