use std::fmt;
use serde::Deserialize;
use serde_json::Value;
use crate::core::models::common::{
Currency, IntentStatus, InvoiceStatus, PaymentMethodType, SubscriptionPeriodUnit,
SubscriptionStatus,
};
use crate::core::models::product::ProductPriceTaxBehavior;
#[derive(Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionResponse {
pub id: String,
pub status: SubscriptionStatus,
#[serde(default)]
pub merchant_reference_id: Option<String>,
#[serde(default)]
pub plan_id: Option<String>,
#[serde(default)]
pub item_price_id: Option<String>,
#[serde(default)]
pub profile_id: Option<String>,
#[serde(default)]
pub client_secret: Option<String>,
#[serde(default)]
pub merchant_id: Option<String>,
#[serde(default)]
pub coupon_code: Option<String>,
#[serde(default)]
pub customer_id: Option<String>,
#[serde(default)]
pub payment: Option<SubscriptionPaymentData>,
#[serde(default)]
pub invoice: Option<SubscriptionInvoice>,
#[serde(default)]
pub product_id: Option<String>,
#[serde(default)]
pub price_id: Option<String>,
#[serde(default)]
pub billing_processor: Option<String>,
#[serde(default)]
pub billing_processor_subscription_id: Option<String>,
#[serde(default)]
pub status_changed_at: Option<String>,
#[serde(default)]
pub renewal_retry: Option<RenewalRetryState>,
#[serde(default)]
pub checkout_method: Option<String>,
#[serde(default)]
pub method_choice_pending: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
impl fmt::Debug for SubscriptionResponse {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("SubscriptionResponse")
.field("id", &self.id)
.field("status", &self.status)
.field("merchant_reference_id", &self.merchant_reference_id)
.field("plan_id", &self.plan_id)
.field("item_price_id", &self.item_price_id)
.field("profile_id", &self.profile_id)
.field(
"client_secret",
&self.client_secret.as_ref().map(|_| "[redacted]"),
)
.field("merchant_id", &self.merchant_id)
.field("coupon_code", &self.coupon_code)
.field("customer_id", &self.customer_id)
.field("payment", &self.payment)
.field("invoice", &self.invoice)
.field("product_id", &self.product_id)
.field("price_id", &self.price_id)
.field("billing_processor", &self.billing_processor)
.field(
"billing_processor_subscription_id",
&self.billing_processor_subscription_id,
)
.field("status_changed_at", &self.status_changed_at)
.field("renewal_retry", &self.renewal_retry)
.field("checkout_method", &self.checkout_method)
.field("method_choice_pending", &self.method_choice_pending)
.field("extra", &self.extra)
.finish()
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct RenewalRetryState {
pub failed_attempts: i32,
#[serde(default)]
pub max_attempts: Option<i32>,
#[serde(default)]
pub next_retry_at: Option<String>,
#[serde(default)]
pub recovery_payment: Option<RenewalRecoveryPayment>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct RenewalRecoveryPayment {
pub payment_id: String,
pub status: String,
pub amount: i64,
pub currency: Currency,
#[serde(default)]
pub payment_link: Option<String>,
pub created_at: String,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct RecoveryPaymentNotice {
pub payment_id: String,
pub invoice_id: String,
pub amount: i64,
pub currency: Currency,
#[serde(default)]
pub payment_link: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ConfirmSubscriptionResponse {
pub id: String,
pub status: SubscriptionStatus,
#[serde(default)]
pub merchant_reference_id: Option<String>,
#[serde(default)]
pub plan_id: Option<String>,
#[serde(default)]
pub item_price_id: Option<String>,
#[serde(default)]
pub coupon: Option<String>,
#[serde(default)]
pub profile_id: Option<String>,
#[serde(default)]
pub customer_id: Option<String>,
#[serde(default)]
pub payment: Option<SubscriptionPaymentData>,
#[serde(default)]
pub invoice: Option<SubscriptionInvoice>,
#[serde(default)]
pub billing_processor_subscription_id: Option<String>,
#[serde(default)]
pub redirect_url: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct PauseSubscriptionResponse {
pub id: String,
pub status: SubscriptionStatus,
#[serde(default)]
pub merchant_reference_id: Option<String>,
#[serde(default)]
pub profile_id: Option<String>,
#[serde(default)]
pub merchant_id: Option<String>,
#[serde(default)]
pub customer_id: Option<String>,
#[serde(default)]
pub paused_at: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct ResumeSubscriptionResponse {
pub id: String,
pub status: SubscriptionStatus,
#[serde(default)]
pub merchant_reference_id: Option<String>,
#[serde(default)]
pub profile_id: Option<String>,
#[serde(default)]
pub merchant_id: Option<String>,
#[serde(default)]
pub customer_id: Option<String>,
#[serde(default)]
pub next_billing_at: Option<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct CancelSubscriptionResponse {
pub id: String,
pub status: SubscriptionStatus,
#[serde(default)]
pub merchant_reference_id: Option<String>,
#[serde(default)]
pub profile_id: Option<String>,
#[serde(default)]
pub merchant_id: Option<String>,
#[serde(default)]
pub customer_id: Option<String>,
#[serde(default)]
pub cancelled_at: Option<String>,
#[serde(default)]
pub cancel_mode_outcome: Option<CancelModeOutcome>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionPaymentData {
pub payment_id: String,
pub status: IntentStatus,
#[serde(default)]
pub amount: Option<i64>,
#[serde(default)]
pub currency: Option<Currency>,
#[serde(default)]
pub next_action: Option<Value>,
#[serde(default)]
pub client_secret: Option<String>,
#[serde(default)]
pub error_code: Option<String>,
#[serde(default)]
pub error_message: Option<String>,
#[serde(default)]
pub payment_method_type: Option<PaymentMethodType>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
impl fmt::Debug for SubscriptionPaymentData {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("SubscriptionPaymentData")
.field("payment_id", &self.payment_id)
.field("status", &self.status)
.field("amount", &self.amount)
.field("currency", &self.currency)
.field("next_action", &self.next_action)
.field(
"client_secret",
&self.client_secret.as_ref().map(|_| "[redacted]"),
)
.field("error_code", &self.error_code)
.field("error_message", &self.error_message)
.field("payment_method_type", &self.payment_method_type)
.field("extra", &self.extra)
.finish()
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionPaymentLink {
pub payment_id: String,
pub subscription_id: String,
pub invoice_id: String,
pub invoice_status: InvoiceStatus,
#[serde(default)]
pub amount_state: Option<InvoiceAmountState>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionPaymentLookupResponse {
#[serde(default)]
pub links: Vec<SubscriptionPaymentLink>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
pub type InvoiceAmountState = String;
pub type CancelModeOutcome = String;
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionInvoice {
pub id: String,
pub subscription_id: String,
pub amount: i64,
#[serde(default)]
pub amount_state: Option<InvoiceAmountState>,
pub currency: Currency,
pub status: InvoiceStatus,
#[serde(default)]
pub merchant_id: Option<String>,
#[serde(default)]
pub profile_id: Option<String>,
#[serde(default)]
pub customer_id: Option<String>,
#[serde(default)]
pub payment_intent_id: Option<String>,
#[serde(default)]
pub payment_method_id: Option<String>,
#[serde(default)]
pub billing_processor_invoice_id: Option<String>,
#[serde(default)]
pub provider_name: Option<String>,
#[serde(default)]
pub tax_amount: Option<i64>,
#[serde(default)]
pub tax_country: Option<String>,
#[serde(default)]
pub net_amount: Option<i64>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionItemPrice {
pub price_id: String,
pub amount: i64,
pub currency: Currency,
#[serde(default)]
pub item_id: Option<String>,
#[serde(default)]
pub interval: Option<SubscriptionPeriodUnit>,
#[serde(default)]
pub interval_count: Option<i64>,
#[serde(default)]
pub trial_period: Option<i64>,
#[serde(default)]
pub trial_period_unit: Option<SubscriptionPeriodUnit>,
#[serde(default)]
pub tax_behavior: Option<ProductPriceTaxBehavior>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionItem {
pub item_id: String,
pub name: String,
#[serde(default)]
pub description: Option<String>,
#[serde(default, rename = "price_id")]
pub prices: Vec<SubscriptionItemPrice>,
#[serde(default)]
pub available: Option<bool>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionLineItem {
pub item_id: String,
pub item_type: String,
#[serde(default)]
pub description: Option<String>,
pub amount: i64,
pub currency: Currency,
#[serde(default)]
pub quantity: Option<i64>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionEstimateResponse {
pub amount: i64,
pub currency: Currency,
#[serde(default)]
pub plan_id: Option<String>,
#[serde(default)]
pub item_price_id: Option<String>,
#[serde(default)]
pub coupon_code: Option<String>,
#[serde(default)]
pub customer_id: Option<String>,
#[serde(default)]
pub line_items: Vec<SubscriptionLineItem>,
#[serde(default)]
pub interval: Option<SubscriptionPeriodUnit>,
#[serde(default)]
pub interval_count: Option<i64>,
#[serde(default)]
pub amount_source: Option<String>,
#[serde(default)]
pub tax_behavior: Option<ProductPriceTaxBehavior>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn subscription_response_decodes_catalog_billing_and_retry_fields() {
let sub: SubscriptionResponse = serde_json::from_str(
r#"{"id":"sub_1","status":"active","product_id":"prod_1","price_id":"prc_1",
"billing_processor":"stripe","billing_processor_subscription_id":"sub_ext",
"status_changed_at":"2026-09-01T00:00:00Z","checkout_method":"paypal",
"method_choice_pending":true,
"renewal_retry":{"failed_attempts":2,"max_attempts":4,"next_retry_at":null,
"recovery_payment":{"payment_id":"pay_9","status":"open","amount":999,
"currency":"EUR","created_at":"2026-09-02T00:00:00Z"}}}"#,
)
.unwrap();
assert_eq!(sub.product_id.as_deref(), Some("prod_1"));
assert_eq!(sub.checkout_method.as_deref(), Some("paypal"));
assert!(sub.method_choice_pending);
let retry = sub.renewal_retry.as_ref().unwrap();
assert_eq!(retry.failed_attempts, 2);
assert_eq!(retry.recovery_payment.as_ref().unwrap().status, "open");
let price: SubscriptionItemPrice = serde_json::from_str(
r#"{"price_id":"prod_1","amount":1000,"currency":"EUR","tax_behavior":"exclusive"}"#,
)
.unwrap();
assert_eq!(price.tax_behavior, Some(ProductPriceTaxBehavior::Exclusive));
let estimate: SubscriptionEstimateResponse = serde_json::from_str(
r#"{"amount":999,"currency":"EUR","amount_source":"plan_list_price"}"#,
)
.unwrap();
assert_eq!(estimate.amount_source.as_deref(), Some("plan_list_price"));
let webhook: LifecycleWebhook = serde_json::from_str(
r#"{"id":"sub_1","subscription_id":"sub_1","customer_id":"cus_1","profile_id":"pro_1",
"status":"past_due","transition_id":"tr_1",
"recovery_payment":{"payment_id":"pay_9","invoice_id":"inv_9","amount":999,
"currency":"EUR","payment_link":"https://checkout.test/pay/pl_9"}}"#,
)
.unwrap();
let notice = webhook.recovery_payment.as_ref().unwrap();
assert_eq!(notice.invoice_id, "inv_9");
assert_eq!(notice.amount, 999);
}
#[test]
fn subscription_response_debug_redacts_the_client_secret() {
let res: SubscriptionResponse = serde_json::from_str(
r#"{"id":"sub_1","status":"active","client_secret":"sub_1_secret_xyz"}"#,
)
.unwrap();
let printed = format!("{res:?}");
assert!(!printed.contains("sub_1_secret_xyz"));
assert!(printed.contains("client_secret: Some(\"[redacted]\")"));
assert!(printed.contains("sub_1"));
}
#[test]
fn subscription_response_debug_shows_none_when_no_client_secret() {
let res: SubscriptionResponse =
serde_json::from_str(r#"{"id":"sub_1","status":"active"}"#).unwrap();
assert!(format!("{res:?}").contains("client_secret: None"));
}
#[test]
fn subscription_payment_data_debug_redacts_the_client_secret() {
let res: SubscriptionResponse = serde_json::from_str(
r#"{"id":"sub_1","status":"active","payment":{"payment_id":"pay_1",
"status":"requires_confirmation","client_secret":"pay_1_secret_nested"}}"#,
)
.unwrap();
let printed = format!("{res:?}");
assert!(!printed.contains("pay_1_secret_nested"));
assert!(printed.contains("pay_1"));
}
#[test]
fn subscription_payment_data_debug_shows_none_when_no_client_secret() {
let data: SubscriptionPaymentData =
serde_json::from_str(r#"{"payment_id":"pay_1","status":"succeeded"}"#).unwrap();
assert!(format!("{data:?}").contains("client_secret: None"));
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct LifecycleWebhook {
pub id: String,
pub subscription_id: String,
#[serde(default)]
pub merchant_reference_id: Option<String>,
pub customer_id: String,
pub profile_id: String,
pub status: SubscriptionStatus,
#[serde(default)]
pub billing_processor_subscription_id: Option<String>,
#[serde(default)]
pub plan_id: Option<String>,
#[serde(default)]
pub item_price_id: Option<String>,
pub transition_id: String,
#[serde(default)]
pub test_mode: Option<bool>,
#[serde(default)]
pub current_period_end: Option<String>,
#[serde(default)]
pub cancelled_at: Option<String>,
#[serde(default)]
pub cancellation_reason: Option<String>,
#[serde(default)]
pub cancel_at_period_end: Option<bool>,
#[serde(default)]
pub recovery_payment: Option<RecoveryPaymentNotice>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
pub type NativeRecoveryMode = String;
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeShopConfigResponse {
pub enabled: bool,
#[serde(default)]
pub payment_connector_id: Option<String>,
pub test_mode: bool,
#[serde(default)]
pub eligible_connectors: Vec<String>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct NativeDunningConfigResponse {
pub enabled: bool,
#[serde(default)]
pub retry_days: Vec<i32>,
pub max_attempts: i32,
pub cancel_after_exhaustion: bool,
pub recovery_mode: NativeRecoveryMode,
pub recovery_after_attempt: i32,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionCapabilities {
pub pause_immediately: bool,
pub resume_immediately: bool,
pub cancel_immediately: bool,
pub cancel_at_period_end: bool,
pub change_plan: bool,
pub pause_voids_invoices: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct AdoptSubscriptionResponse {
pub subscription_id: String,
pub adopted: bool,
pub billing_processor: String,
#[serde(default)]
pub merchant_connector_id: Option<String>,
#[serde(default)]
pub external_subscription_id: Option<String>,
pub status: SubscriptionStatus,
pub customer_id: String,
pub profile_id: String,
#[serde(default)]
pub merchant_reference_id: Option<String>,
#[serde(default)]
pub plan_id: Option<String>,
#[serde(default)]
pub item_price_id: Option<String>,
#[serde(default)]
pub test_mode: Option<bool>,
#[serde(default)]
pub adopted_at: Option<String>,
pub handoff_confirmed: bool,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
pub type SubscriptionImportReason = String;
pub type SubscriptionImportClassification = String;
pub type SubscriptionImportOutcome = String;
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionImportCapabilities {
pub connector: String,
pub listing: bool,
pub adoption: bool,
#[serde(default)]
pub reason: Option<String>,
#[serde(default)]
pub reason_code: Option<SubscriptionImportReason>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionImportCounts {
#[serde(default)]
pub new: i32,
#[serde(default)]
pub needs_customer: i32,
#[serde(default)]
pub held: i32,
#[serde(default)]
pub ended: i32,
#[serde(default)]
pub not_adoptable: i32,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionImportItem {
pub external_subscription_id: String,
pub provider_status: String,
#[serde(default)]
pub status: Option<SubscriptionStatus>,
#[serde(default)]
pub item_price_id: Option<String>,
#[serde(default)]
pub connector_customer_id: Option<String>,
#[serde(default)]
pub customer_email: Option<String>,
#[serde(default)]
pub customer_id: Option<String>,
pub classification: SubscriptionImportClassification,
#[serde(default)]
pub subscription_id: Option<String>,
#[serde(default)]
pub note: Option<String>,
#[serde(default)]
pub note_code: Option<SubscriptionImportReason>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
impl fmt::Debug for SubscriptionImportItem {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("SubscriptionImportItem")
.field("external_subscription_id", &self.external_subscription_id)
.field("provider_status", &self.provider_status)
.field("status", &self.status)
.field("item_price_id", &self.item_price_id)
.field("connector_customer_id", &self.connector_customer_id)
.field(
"customer_email",
&self.customer_email.as_ref().map(|_| "[redacted]"),
)
.field("customer_id", &self.customer_id)
.field("classification", &self.classification)
.field("subscription_id", &self.subscription_id)
.field("note", &self.note)
.field("note_code", &self.note_code)
.field("extra", &self.extra)
.finish()
}
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionImportPreviewResponse {
pub capabilities: SubscriptionImportCapabilities,
pub counts: SubscriptionImportCounts,
#[serde(default)]
pub truncated: bool,
#[serde(default)]
pub items: Vec<SubscriptionImportItem>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionImportResult {
pub external_subscription_id: String,
pub outcome: SubscriptionImportOutcome,
#[serde(default)]
pub subscription_id: Option<String>,
#[serde(default)]
pub reason: Option<String>,
#[serde(default)]
pub reason_code: Option<SubscriptionImportReason>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionImportApplyResponse {
#[serde(default)]
pub results: Vec<SubscriptionImportResult>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
pub type SubscriptionSyncOutcome = String;
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionProviderRead {
pub billing_processor_subscription_id: String,
#[serde(default)]
pub status: Option<SubscriptionStatus>,
#[serde(default)]
pub status_changed_at: Option<String>,
#[serde(default)]
pub item_price_id: Option<String>,
#[serde(default)]
pub customer_id: Option<String>,
pub read_at: String,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionSyncResult {
pub subscription_id: String,
pub outcome: SubscriptionSyncOutcome,
#[serde(default)]
pub status: Option<SubscriptionStatus>,
#[serde(default)]
pub provider: Option<SubscriptionProviderRead>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionSyncResponse {
#[serde(default)]
pub results: Vec<SubscriptionSyncResult>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionInvoiceListResponse {
#[serde(default)]
pub invoices: Vec<SubscriptionInvoice>,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}
#[derive(Debug, Clone, Deserialize)]
#[non_exhaustive]
pub struct SubscriptionBillingProcessorResponse {
pub merchant_connector_id: String,
pub connector_name: String,
#[serde(flatten)]
pub extra: serde_json::Map<String, Value>,
}