StoreBillingStatusDto
alertsStoreAlertDto[]Required
idFlakeIdRequired
admin_visiblebooleanRequired
created_atstringRequired
metadataobjectRequired
statusenumRequired
Possible enum values
infowarningaction_requiredresolved
store_idFlakeIdRequired
store_visiblebooleanRequired
typeenumRequired
Possible enum values
otherexcessive_chargeback_ratekyc_requiredbusiness_details_requiredincreased_fraud_rateunsupported_productproduct_compliance_checkintegration_issuestorefront_compliancesupport_inquiryfeature_eligibilityfeature_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
inherits_from_plan_idstringOptional
plan_limitsobjectRequired
plan_pricingPlanPricingDtoRequired
idFlakeIdRequired
begins_atstringRequired
plan_idstringRequired
platform_fee_rateintegerRequired
subscription_price_monthlyintegerRequired
ends_atstringOptional
revenue_limit_exceededbooleanOptional
subscription_price_annuallyintegerOptional
revenue_usageintegerRequired
store_idFlakeIdRequired
lock_reasonstringOptional
payment_methodPaymentMethodDtoOptionalRepresents a stored payment method
idFlakeIdRequired
created_atstringRequired
The date and time when this payment method was created
customer_idFlakeIdRequired
gatewaystringRequired
The payment gateway provider
gateway_customer_idstringRequired
The gateway's customer identifier
gateway_entity_identifierstringRequired
The gateway entity identifier
gateway_idstringRequired
The gateway's identifier for this payment method
gateway_typestringRequired
The gateway-specific type identifier
method_detailsPaymentMethodDetailsDtoRequiredContains detailed information about a payment method.
DISCLAIMER: These fields are not guaranteed to be backwards compatible and may change or be removed without notice.
alipayAlipayDetailsDtoOptional
→ AlipayDetailsDtobancontactBancontactDetailsDtoOptional
→ BancontactDetailsDtocardCardDetailsDtoOptional
→ CardDetailsDtocashappCashAppDetailsDtoOptional
→ CashAppDetailsDtocryptoCryptoDetailsDtoOptional
→ CryptoDetailsDtoidealIdealDetailsDtoOptional
→ IdealDetailsDtoklarnaKlarnaDetailsDtoOptional
→ KlarnaDetailsDtolinkLinkDetailsDtoOptional
→ LinkDetailsDtop24P24DetailsDtoOptional
→ P24DetailsDtopay_by_bankPayByBankDetailsDtoOptional
→ PayByBankDetailsDtopaypalPayPalDetailsDtoOptional
→ PayPalDetailsDtopaysafecardPaysafeCardDetailsDtoOptional
→ PaysafeCardDetailsDtopixPixDetailsDtoOptional
→ PixDetailsDtosteamskinsSteamSkinsDetailsDtoOptional
→ SteamSkinsDetailsDtomethod_typestringRequired
The payment method type
updated_atstringOptional
The date and time when this payment method was last updated
subscriptionStoreSubscriptionDtoOptional
idFlakeIdRequired
cancel_at_period_endbooleanRequired
created_atstringRequired
currencystringRequired
gatewaystringRequired
gateway_checkout_idstringRequired
gateway_payment_method_idstringRequired
gateway_subscription_idstringRequired
plan_idstringRequired
renewal_periodenumRequired
Possible enum values
monthlyannually
statusenumRequired
Possible enum values
incompletetrialingactiverequires_actioncanceled
store_idFlakeIdRequired
user_idFlakeIdRequired
cancel_atstringOptional
current_period_endstringOptional
current_period_startstringOptional
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",
"inherits_from_plan_id": "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",
"revenue_limit_exceeded": true,
"subscription_price_annually": 0
},
"revenue_usage": 0,
"store_id": "411486491630370816",
"lock_reason": "string",
"payment_method": {
"id": "411486491630370816",
"created_at": "2025-03-15T10:20:30Z",
"customer_id": "411486491630370816",
"gateway": "string",
"gateway_customer_id": "string",
"gateway_entity_identifier": "string",
"gateway_id": "string",
"gateway_type": "card",
"method_details": {
"alipay": {
"buyer_id": "buyer_abc123",
"fingerprint": "fingerprint_xyz789"
},
"bancontact": {
"bank": "bnp_paribas",
"bank_name": "BNP Paribas",
"bic": "GEBABEBB",
"iban_last4": 3456,
"payer_name": "Jean Dupont"
},
"card": {
"brand": "visa",
"country": "US",
"exp_month": 12,
"exp_year": 2028,
"fingerprint": "abc123def456",
"funding": "credit",
"last4": "4242",
"bin": 424242,
"brand_product": "F",
"description": "Visa Signature",
"issuer": "Chase Bank",
"wallet": {
"type": "apple_pay"
}
},
"cashapp": {
"buyer_id": "buyer_abc123",
"cashtag": "$johndoe"
},
"crypto": {
"confirmations": 6,
"crypto_amount": "0.00150000",
"crypto_currency": "BTC",
"total_paid": "0.00150000",
"transaction_hashes": [
"string"
]
},
"ideal": {
"bank": "abn_amro",
"bic": "ABNANL2A",
"iban_last4": 1234,
"payer_name": "John Doe"
},
"klarna": {
"country": "SE",
"method_category": "pay_later"
},
"link": {
"email": "[email protected]"
},
"p24": {
"bank": "ing",
"payer_name": "Jan Kowalski"
},
"pay_by_bank": {
"bank_name": "Chase Bank",
"bic": "CHASUS33",
"country": "US",
"payer_name": "John Smith"
},
"paypal": {
"country": "US",
"payer_email": "[email protected]",
"payer_id": "PAYERID123",
"payer_name": "John Doe",
"vault": true,
"pending_vault_approval": false,
"standalone_setup": false
},
"paysafecard": {
"association_id": "string",
"first_name": "string",
"last_name": "string",
"psc_id": "string"
},
"pix": {
"bank_account_number": "12345-6",
"bank_name": "Banco do Brasil",
"payer_name": "João Silva"
},
"steamskins": {
"items": [
{
"id": "string",
"app_id": 730,
"name": "AK-47 | Redline",
"price": 2500
}
]
}
},
"method_type": "card",
"updated_at": "2025-03-20T14:30:00Z"
},
"subscription": {
"id": "411486491630370816",
"cancel_at_period_end": true,
"created_at": "2024-01-01T00:00:00Z",
"currency": "string",
"gateway": "string",
"gateway_checkout_id": "string",
"gateway_payment_method_id": "string",
"gateway_subscription_id": "string",
"plan_id": "string",
"renewal_period": "monthly",
"status": "incomplete",
"store_id": "411486491630370816",
"user_id": "411486491630370816",
"cancel_at": "2024-01-01T00:00:00Z",
"current_period_end": "2024-01-01T00:00:00Z",
"current_period_start": "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"
}
}