No record of coupon / promotion code stored w/ subscription.

[zackgilbert]

I've been working on implementing the usage of promotion codes and coupons to allow discounts to users. Overall, this was super easy to implement with the gem, but one thing I noticed was that when a coupon or promotion code is used, it's not stored w/ the subscription, so you wouldn't know (until you look at charges) that the user had a discounted subscription.

Not sure if this is a bug or just not accounted for yet? I'd think either a new "discount" field could be added or maybe this could be stored in the data or metadata fields (this is what I'm doing now, manually adding it to the metadata)?

Additional information...

What gets stored on the subscription:

irb(main):010:0> u.subscription
  Pay::Subscription Load (12.1ms)  SELECT "pay_subscriptions".* FROM "pay_subscriptions" INNER JOIN "pay_customers" ON "pay_subscriptions"."customer_id" = "pay_customers"."id" WHERE "pay_customers"."owner_id" = $1 AND "pay_customers"."owner_type" = $2 AND "pay_customers"."default" = $3 AND "pay_customers"."deleted_at" IS NULL ORDER BY "pay_subscriptions"."created_at" DESC LIMIT $4  [["owner_id", "d6d17f46-61dc-431f-b2c4-fcb8a0b5f7fb"], ["owner_type", "User"], ["default", true], ["LIMIT", 1]]
=> 
#<Pay::Subscription:0x00007fbca18a9fe8
 id: "795dda2c-164c-4b23-9c87-c4c9c1588367",
 customer_id: "0b2b48f2-ee13-42e1-8256-ebba29624e4e",
 name: "default",
 processor_id: "sub_1MFhn2LQgc8mxvfYwq5wgocf",
 processor_plan: "price_1MCQECLQgc8mxvfYBKN9RfoZ",
 quantity: 1,
 status: "active",
 trial_ends_at: nil,
 ends_at: nil,
 application_fee_percent: nil,
 metadata: {},
 data:
  {"subscription_items"=>
    [{"id"=>"si_MzhBETF80jMD0R",
      "price"=>
       {"id"=>"price_1MCQECLQgc8mxvfYBKN9RfoZ",
        "type"=>"recurring",
        "active"=>true,
        "object"=>"price",
        "created"=>1670429532,
        "product"=>"prod_MjFIwK26sQBZmx",
        "currency"=>"usd",
        "livemode"=>false,
        "metadata"=>{},
        "nickname"=>"Pro Monthly",
        "recurring"=>{"interval"=>"month", "usage_type"=>"licensed", "interval_count"=>1, "aggregate_usage"=>nil, "trial_period_days"=>nil},
        "lookup_key"=>nil,
        "tiers_mode"=>nil,
        "unit_amount"=>1500,
        "tax_behavior"=>"unspecified",
        "billing_scheme"=>"per_unit",
        "custom_unit_amount"=>nil,
        "transform_quantity"=>nil,
        "unit_amount_decimal"=>"1500"},
      "metadata"=>{},
      "quantity"=>1}]},
 created_at: Fri, 16 Dec 2022 17:33:44.000000000 UTC +00:00,
 updated_at: Fri, 16 Dec 2022 17:33:46.453656000 UTC +00:00,
 current_period_start: Fri, 16 Dec 2022 17:33:44.000000000 UTC +00:00,
 current_period_end: Mon, 16 Jan 2023 17:33:44.000000000 UTC +00:00,
 metered: false,
 pause_behavior: nil,
 pause_starts_at: nil,
 pause_resumes_at: nil,
 prorate: true>

Request POST body (to STRIPE):

{
  "coupon": "testing25",
  "expand": {
    "0": "pending_setup_intent",
    "1": "latest_invoice.payment_intent",
    "2": "latest_invoice.charge",
    "3": "latest_invoice.total_discount_amounts.discount",
    "4": "latest_invoice.total_tax_amounts.tax_rate"
  },
  "items": {
    "0": {
      "plan": "price_1MCQECLQgc8mxvfYBKN9RfoZ"
    }
  },
  "customer": "cus_MyGDLwqDlK84yM"
}

Response body:

{
  "id": "sub_1MFhn2LQgc8mxvfYwq5wgocf",
  "object": "subscription",
  "application": null,
  "application_fee_percent": null,
  "automatic_tax": {
    "enabled": false
  },
  "billing_cycle_anchor": 1671212024,
  "billing_thresholds": null,
  "cancel_at": null,
  "cancel_at_period_end": false,
  "canceled_at": null,
  "collection_method": "charge_automatically",
  "created": 1671212024,
  "currency": "usd",
  "current_period_end": 1673890424,
  "current_period_start": 1671212024,
  "customer": "cus_MyGDLwqDlK84yM",
  "days_until_due": null,
  "default_payment_method": null,
  "default_source": null,
  "default_tax_rates": [
  ],
  "description": null,
  "discount": {
    "id": "di_1MFhn2LQgc8mxvfYcenCS4Mb",
    "object": "discount",
    "checkout_session": null,
    "coupon": {
      "id": "testing25",
      "object": "coupon",
      "amount_off": null,
      "created": 1671209209,
      "currency": null,
      "duration": "forever",
      "duration_in_months": null,
      "livemode": false,
      "max_redemptions": null,
      "metadata": {
      },
      "name": "Testing 25%",
      "percent_off": 25,
      "redeem_by": null,
      "times_redeemed": 1,
      "valid": true
    },
    "customer": "cus_MyGDLwqDlK84yM",
    "end": null,
    "invoice": null,
    "invoice_item": null,
    "promotion_code": null,
    "start": 1671212024,
    "subscription": "sub_1MFhn2LQgc8mxvfYwq5wgocf"
  },
  "ended_at": null,
  "items": {
    "object": "list",
    "data": [
      {
        "id": "si_MzhBETF80jMD0R",
        "object": "subscription_item",
        "billing_thresholds": null,
        "created": 1671212025,
        "metadata": {
        },
        "plan": {
          "id": "price_1MCQECLQgc8mxvfYBKN9RfoZ",
          "object": "plan",
          "active": true,
          "aggregate_usage": null,
          "amount": 1500,
          "amount_decimal": "1500",
          "billing_scheme": "per_unit",
          "created": 1670429532,
          "currency": "usd",
          "interval": "month",
          "interval_count": 1,
          "livemode": false,
          "metadata": {
          },
          "nickname": "Pro Monthly",
          "product": "prod_MjFIwK26sQBZmx",
          "tiers_mode": null,
          "transform_usage": null,
          "trial_period_days": null,
          "usage_type": "licensed"
        },
        "price": {
          "id": "price_1MCQECLQgc8mxvfYBKN9RfoZ",
          "object": "price",
          "active": true,
          "billing_scheme": "per_unit",
          "created": 1670429532,
          "currency": "usd",
          "custom_unit_amount": null,
          "livemode": false,
          "lookup_key": null,
          "metadata": {
          },
          "nickname": "Pro Monthly",
          "product": "prod_MjFIwK26sQBZmx",
          "recurring": {
            "aggregate_usage": null,
            "interval": "month",
            "interval_count": 1,
            "trial_period_days": null,
            "usage_type": "licensed"
          },
          "tax_behavior": "unspecified",
          "tiers_mode": null,
          "transform_quantity": null,
          "type": "recurring",
          "unit_amount": 1500,
          "unit_amount_decimal": "1500"
        },
        "quantity": 1,
        "subscription": "sub_1MFhn2LQgc8mxvfYwq5wgocf",
        "tax_rates": [
        ]
      }
    ],
    "has_more": false,
    "total_count": 1,
    "url": "/v1/subscription_items?subscription=sub_1MFhn2LQgc8mxvfYwq5wgocf"
  },
  "latest_invoice": {
    "id": "in_1MFhn2LQgc8mxvfYiZ44iNja",
    "object": "invoice",
    "account_country": "US",
    "account_name": "Safehold, Inc.",
    "account_tax_ids": null,
    "amount_due": 1125,
    "amount_paid": 1125,
    "amount_remaining": 0,
    "application": null,
    "application_fee_amount": null,
    "attempt_count": 1,
    "attempted": true,
    "auto_advance": false,
    "automatic_tax": {
      "enabled": false,
      "status": null
    },
    "billing_reason": "subscription_create",
    "charge": {
      "id": "py_3MFhn2LQgc8mxvfY0vbIGMyF",
      "object": "charge",
      "amount": 1125,
      "amount_captured": 1125,
      "amount_refunded": 0,
      "application": null,
      "application_fee": null,
      "application_fee_amount": null,
      "balance_transaction": "txn_3MFhn2LQgc8mxvfY0OF3Q72X",
      "billing_details": {
        "address": {
          "city": null,
          "country": null,
          "line1": null,
          "line2": null,
          "postal_code": null,
          "state": null
        },
        "email": null,
        "name": null,
        "phone": null
      },
      "calculated_statement_descriptor": null,
      "captured": true,
      "created": 1671212025,
      "currency": "usd",
      "customer": "cus_MyGDLwqDlK84yM",
      "description": "Subscription creation",
      "destination": null,
      "dispute": null,
      "disputed": false,
      "failure_balance_transaction": null,
      "failure_code": null,
      "failure_message": null,
      "fraud_details": {
      },
      "invoice": "in_1MFhn2LQgc8mxvfYiZ44iNja",
      "livemode": false,
      "metadata": {
      },
      "on_behalf_of": null,
      "order": null,
      "outcome": {
        "network_status": "approved_by_network",
        "reason": null,
        "risk_level": "not_assessed",
        "seller_message": "Payment complete.",
        "type": "authorized"
      },
      "paid": true,
      "payment_intent": "pi_3MFhn2LQgc8mxvfY04WkDDA1",
      "payment_method": null,
      "payment_method_details": {
        "ach_debit": {
          "account_holder_type": null,
          "bank_name": "STRIPE TEST BANK",
          "country": "US",
          "fingerprint": "kpiB9c2gN3P1fWnP",
          "last4": "6789",
          "routing_number": "110000000"
        },
        "type": "ach_debit"
      },
      "receipt_email": null,
      "receipt_number": null,
      "receipt_url": "https://pay.stripe.com/receipts/invoices/CAcaFwoVYWNjdF8xSnJRYTJMUWdjOG14dmZZKPrX8pwGMgaa-sciq4U6LBZpH0B9VDOPBC6qdS1AjAsCe2ax6r0GAcYF5UNQ5NaJSlVoQBy_JXpRa2jU?s=ap",
      "refunded": false,
      "review": null,
      "shipping": null,
      "source": {
        "id": "ba_1MFhn1LQgc8mxvfY0cWTQhd5",
        "object": "bank_account",
        "account_holder_name": null,
        "account_holder_type": null,
        "account_type": null,
        "bank_name": "STRIPE TEST BANK",
        "country": "US",
        "currency": "usd",
        "customer": "cus_MyGDLwqDlK84yM",
        "fingerprint": "kpiB9c2gN3P1fWnP",
        "last4": "6789",
        "metadata": {
        },
        "routing_number": "110000000",
        "status": "verified"
      },
      "source_transfer": null,
      "statement_descriptor": "ABLE.COM/PRO",
      "statement_descriptor_suffix": null,
      "status": "succeeded",
      "transfer_data": null,
      "transfer_group": null
    },
    "collection_method": "charge_automatically",
    "created": 1671212024,
    "currency": "usd",
    "custom_fields": null,
    "customer": "cus_MyGDLwqDlK84yM",
    "customer_address": null,
    "customer_email": "zackgilbert@gmail.com",
    "customer_name": "Zack",
    "customer_phone": null,
    "customer_shipping": null,
    "customer_tax_exempt": "none",
    "customer_tax_ids": [
    ],
    "default_payment_method": null,
    "default_source": null,
    "default_tax_rates": [
    ],
    "description": null,
    "discount": {
      "id": "di_1MFhn2LQgc8mxvfYcenCS4Mb",
      "object": "discount",
      "checkout_session": null,
      "coupon": {
        "id": "testing25",
        "object": "coupon",
        "amount_off": null,
        "created": 1671209209,
        "currency": null,
        "duration": "forever",
        "duration_in_months": null,
        "livemode": false,
        "max_redemptions": null,
        "metadata": {
        },
        "name": "Testing 25%",
        "percent_off": 25,
        "redeem_by": null,
        "times_redeemed": 1,
        "valid": true
      },
      "customer": "cus_MyGDLwqDlK84yM",
      "end": null,
      "invoice": null,
      "invoice_item": null,
      "promotion_code": null,
      "start": 1671212024,
      "subscription": "sub_1MFhn2LQgc8mxvfYwq5wgocf"
    },
    "discounts": [
      "di_1MFhn2LQgc8mxvfYcenCS4Mb"
    ],
    "due_date": null,
    "ending_balance": 0,
    "footer": null,
    "from_invoice": null,
    "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1JrQa2LQgc8mxvfY/test_YWNjdF8xSnJRYTJMUWdjOG14dmZZLF9NemhCd1BwODExOElTT202anZZTjVJSTBEcWdDOW5FLDYxNzUyODI202009tE769tt?s=ap",
    "invoice_pdf": "https://pay.stripe.com/invoice/acct_1JrQa2LQgc8mxvfY/test_YWNjdF8xSnJRYTJMUWdjOG14dmZZLF9NemhCd1BwODExOElTT202anZZTjVJSTBEcWdDOW5FLDYxNzUyODI202009tE769tt/pdf?s=ap",
    "last_finalization_error": null,
    "latest_revision": null,
    "lines": {
      "object": "list",
      "data": [
        {
          "id": "il_1MFhn2LQgc8mxvfYyiO3UdXM",
          "object": "line_item",
          "amount": 1500,
          "amount_excluding_tax": 1500,
          "currency": "usd",
          "description": "1 × Able Pro (at $15.00 / month)",
          "discount_amounts": [
            {
              "amount": 375,
              "discount": "di_1MFhn2LQgc8mxvfYcenCS4Mb"
            }
          ],
          "discountable": true,
          "discounts": [
          ],
          "livemode": false,
          "metadata": {
          },
          "period": {
            "end": 1673890424,
            "start": 1671212024
          },
          "plan": {
            "id": "price_1MCQECLQgc8mxvfYBKN9RfoZ",
            "object": "plan",
            "active": true,
            "aggregate_usage": null,
            "amount": 1500,
            "amount_decimal": "1500",
            "billing_scheme": "per_unit",
            "created": 1670429532,
            "currency": "usd",
            "interval": "month",
            "interval_count": 1,
            "livemode": false,
            "metadata": {
            },
            "nickname": "Pro Monthly",
            "product": "prod_MjFIwK26sQBZmx",
            "tiers_mode": null,
            "transform_usage": null,
            "trial_period_days": null,
            "usage_type": "licensed"
          },
          "price": {
            "id": "price_1MCQECLQgc8mxvfYBKN9RfoZ",
            "object": "price",
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1670429532,
            "currency": "usd",
            "custom_unit_amount": null,
            "livemode": false,
            "lookup_key": null,
            "metadata": {
            },
            "nickname": "Pro Monthly",
            "product": "prod_MjFIwK26sQBZmx",
            "recurring": {
              "aggregate_usage": null,
              "interval": "month",
              "interval_count": 1,
              "trial_period_days": null,
              "usage_type": "licensed"
            },
            "tax_behavior": "unspecified",
            "tiers_mode": null,
            "transform_quantity": null,
            "type": "recurring",
            "unit_amount": 1500,
            "unit_amount_decimal": "1500"
          },
          "proration": false,
          "proration_details": {
            "credited_items": null
          },
          "quantity": 1,
          "subscription": "sub_1MFhn2LQgc8mxvfYwq5wgocf",
          "subscription_item": "si_MzhBETF80jMD0R",
          "tax_amounts": [
          ],
          "tax_rates": [
          ],
          "type": "subscription",
          "unit_amount_excluding_tax": "1500"
        }
      ],
      "has_more": false,
      "total_count": 1,
      "url": "/v1/invoices/in_1MFhn2LQgc8mxvfYiZ44iNja/lines"
    },
    "livemode": false,
    "metadata": {
    },
    "next_payment_attempt": null,
    "number": "7CCEDBDB-0026",
    "on_behalf_of": null,
    "paid": true,
    "paid_out_of_band": false,
    "payment_intent": {
      "id": "pi_3MFhn2LQgc8mxvfY04WkDDA1",
      "object": "payment_intent",
      "amount": 1125,
      "amount_capturable": 0,
      "amount_details": {
        "tip": {
        }
      },
      "amount_received": 1125,
      "application": null,
      "application_fee_amount": null,
      "automatic_payment_methods": null,
      "canceled_at": null,
      "cancellation_reason": null,
      "capture_method": "automatic",
      "client_secret": "SCRUBBED",
      "confirmation_method": "automatic",
      "created": 1671212024,
      "currency": "usd",
      "customer": "cus_MyGDLwqDlK84yM",
      "description": "Subscription creation",
      "invoice": "in_1MFhn2LQgc8mxvfYiZ44iNja",
      "last_payment_error": null,
      "latest_charge": "py_3MFhn2LQgc8mxvfY0vbIGMyF",
      "livemode": false,
      "metadata": {
      },
      "next_action": null,
      "on_behalf_of": null,
      "payment_method": null,
      "payment_method_options": {
        "card": {
          "installments": null,
          "mandate_options": null,
          "network": null,
          "request_three_d_secure": "automatic"
        }
      },
      "payment_method_types": [
        "ach_debit",
        "card"
      ],
      "processing": null,
      "receipt_email": null,
      "review": null,
      "setup_future_usage": null,
      "shipping": null,
      "source": "ba_1MFhn1LQgc8mxvfY0cWTQhd5",
      "statement_descriptor": "ABLE.COM/PRO",
      "statement_descriptor_suffix": null,
      "status": "succeeded",
      "transfer_data": null,
      "transfer_group": null
    },
    "payment_settings": {
      "default_mandate": null,
      "payment_method_options": null,
      "payment_method_types": null
    },
    "period_end": 1671212024,
    "period_start": 1671212024,
    "post_payment_credit_notes_amount": 0,
    "pre_payment_credit_notes_amount": 0,
    "quote": null,
    "receipt_number": null,
    "rendering_options": null,
    "starting_balance": 0,
    "statement_descriptor": null,
    "status": "paid",
    "status_transitions": {
      "finalized_at": 1671212024,
      "marked_uncollectible_at": null,
      "paid_at": 1671212024,
      "voided_at": null
    },
    "subscription": "sub_1MFhn2LQgc8mxvfYwq5wgocf",
    "subtotal": 1500,
    "subtotal_excluding_tax": 1500,
    "tax": null,
    "test_clock": null,
    "total": 1125,
    "total_discount_amounts": [
      {
        "amount": 375,
        "discount": {
          "id": "di_1MFhn2LQgc8mxvfYcenCS4Mb",
          "object": "discount",
          "checkout_session": null,
          "coupon": {
            "id": "testing25",
            "object": "coupon",
            "amount_off": null,
            "created": 1671209209,
            "currency": null,
            "duration": "forever",
            "duration_in_months": null,
            "livemode": false,
            "max_redemptions": null,
            "metadata": {
            },
            "name": "Testing 25%",
            "percent_off": 25,
            "redeem_by": null,
            "times_redeemed": 1,
            "valid": true
          },
          "customer": "cus_MyGDLwqDlK84yM",
          "end": null,
          "invoice": null,
          "invoice_item": null,
          "promotion_code": null,
          "start": 1671212024,
          "subscription": "sub_1MFhn2LQgc8mxvfYwq5wgocf"
        }
      }
    ],
    "total_excluding_tax": 1125,
    "total_tax_amounts": [
    ],
    "transfer_data": null,
    "webhooks_delivered_at": 1671212024
  },
  "livemode": false,
  "metadata": {
  },
  "next_pending_invoice_item_invoice": null,
  "on_behalf_of": null,
  "pause_collection": null,
  "payment_settings": {
    "payment_method_options": null,
    "payment_method_types": null,
    "save_default_payment_method": "off"
  },
  "pending_invoice_item_interval": null,
  "pending_setup_intent": null,
  "pending_update": null,
  "plan": {
    "id": "price_1MCQECLQgc8mxvfYBKN9RfoZ",
    "object": "plan",
    "active": true,
    "aggregate_usage": null,
    "amount": 1500,
    "amount_decimal": "1500",
    "billing_scheme": "per_unit",
    "created": 1670429532,
    "currency": "usd",
    "interval": "month",
    "interval_count": 1,
    "livemode": false,
    "metadata": {
    },
    "nickname": "Pro Monthly",
    "product": "prod_MjFIwK26sQBZmx",
    "tiers_mode": null,
    "transform_usage": null,
    "trial_period_days": null,
    "usage_type": "licensed"
  },
  "quantity": 1,
  "schedule": null,
  "start_date": 1671212024,
  "status": "active",
  "test_clock": null,
  "transfer_data": null,
  "trial_end": null,
  "trial_start": null
}

[excid3]

We don't support coupons / discounts yet. Haven't decided if we need to we should shove this into the Pay::Subscription or if we need to introduce another model (ideally we don't).

Coupons on Stripe apply to both Customers and Subscriptions as well.

Ideally, we also support this for Braintree & Paddle which is why it's easier said than done.

[zackgilbert]

@excid3 Totally fair. Just thought I'd mention it as I ran into it. Honestly, I'm impressed with how easy it was to support with Stripe, so kudos. Not a blocker for me, so definitely understand if it's a "down the line" thing. Thanks!

[rathboma]

@excid3 if I wanted to modify the sync code to store the coupon from stripe during a webhook how would I do that?

[excid3]

You can override the method.