feat(subscriptions): Add client secret auth support in subscriptions APIs by Sarthak1799 · Pull Request #9713 · juspay/hyperswitch

Sarthak1799 · 2025-10-07T12:46:18Z

Type of Change

Description

This pull request introduces several enhancements and refactors to the subscription API, focusing on improving authentication, response structure, and data handling. The main changes include adding payment and invoice details to subscription responses, updating authentication logic to support client secrets in queries, and refactoring handler methods for better error handling and extensibility.

Subscription Response Improvements

Added payment and invoice fields to the SubscriptionResponse struct to provide more detailed information about payments and invoices associated with a subscription.
Updated the PaymentResponseData struct to use a Secret<String> for the client_secret field, improving security and consistency.

Authentication and Query Handling

Introduced a new GetSubscriptionQuery struct to allow passing a client secret when fetching subscription details, and implemented ClientSecretFetch for relevant subscription request/query types. [1] [2]
Refactored authentication logic in subscription route handlers (get_subscription, get_subscription_plans, and confirm_subscription) to extract and validate client secrets from query payloads, improving security and flexibility. [1] [2] [3] [4]

Handler and Response Refactoring

Refactored the to_subscription_response method in SubscriptionWithHandler to accept optional payment and invoice parameters, and handle invoice conversion with error reporting for invalid currency values. [1] [2]
Updated core subscription logic to use the new response structure and refactored method signatures for consistency, including changes to how responses are generated and returned. [1] [2] [3] [4]

These changes collectively improve the robustness and extensibility of the subscription API, making it easier to integrate payment and invoice details while strengthening authentication mechanisms.

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

How did you test it?

Subscription create

curl --location 'http://localhost:8080/subscriptions/create' \
--header 'Content-Type: application/json' \
--header 'X-Profile-Id: pro_CohRshEanxkKSMHgyu6a' \
--header 'api-key: dev_tV0O30052zhBCqdrhGMfQxMN0DerXwnMkNHX6ndCbs0BovewetTaXznBQOCLGAi2' \
--data '{
    "customer_id": "cus_d64F9yomaDMqbTDlxw3g",
    "amount": 14100,
    "currency": "USD",
    "payment_details": {
        "authentication_type": "no_three_ds",
        "setup_future_usage": "off_session",
        "capture_method": "automatic",
        "return_url": "https://google.com"
    }
}'

Response -

{"id":"sub_8zxmAZAfS0eTL8zRJRk7","merchant_reference_id":null,"status":"created","plan_id":null,"profile_id":"pro_CohRshEanxkKSMHgyu6a","client_secret":"sub_8zxmAZAfS0eTL8zRJRk7_secret_IGg9yCNzrzoziV3odFLt","merchant_id":"merchant_1759849271","coupon_code":null,"customer_id":"cus_d64F9yomaDMqbTDlxw3g","payment":{"payment_id":"pay_pPn6Tz2m3WrOIzANMF2g","status":"requires_payment_method","amount":14100,"currency":"USD","connector":null,"payment_method_id":null,"payment_experience":null,"error_code":null,"error_message":null,"payment_method_type":null,"client_secret":"pay_pPn6Tz2m3WrOIzANMF2g_secret_Wxi6r52cBxz0ujhcWpAh"},"invoice":{"id":"invoice_nEqu7GMVqNMRzBorC9BS","subscription_id":"sub_8zxmAZAfS0eTL8zRJRk7","merchant_id":"merchant_1759849271","profile_id":"pro_CohRshEanxkKSMHgyu6a","merchant_connector_id":"mca_S0OzkqOOhMZs2jJQPSZo","payment_intent_id":"pay_pPn6Tz2m3WrOIzANMF2g","payment_method_id":null,"customer_id":"cus_d64F9yomaDMqbTDlxw3g","amount":14100,"currency":"USD","status":"invoice_created"}}

Get plans

curl --location 'http://localhost:8080/subscriptions/plans?limit=2&offset=0&client_secret=sub_8zxmAZAfS0eTL8zRJRk7_secret_IGg9yCNzrzoziV3odFLt' \
--header 'Content-Type: application/json' \
--header 'api-key: pk_dev_febeb0fab3be43c79024efaf99764d63' \
--header 'X-Profile-Id: pro_CohRshEanxkKSMHgyu6a'

Response -

[{"plan_id":"cbdemo_enterprise-suite","name":"Enterprise Suite","description":"High-end customer support suite with enterprise-grade solutions.","price_id":[{"price_id":"cbdemo_enterprise-suite-monthly","plan_id":"cbdemo_enterprise-suite","amount":14100,"currency":"INR","interval":"Month","interval_count":1,"trial_period":null,"trial_period_unit":null},{"price_id":"cbdemo_enterprise-suite-annual","plan_id":"cbdemo_enterprise-suite","amount":169000,"currency":"INR","interval":"Year","interval_count":1,"trial_period":null,"trial_period_unit":null}]},{"plan_id":"cbdemo_business-suite","name":"Business Suite","description":"Advanced customer support plan with premium features.","price_id":[{"price_id":"cbdemo_business-suite-monthly","plan_id":"cbdemo_business-suite","amount":9600,"currency":"INR","interval":"Month","interval_count":1,"trial_period":null,"trial_period_unit":null},{"price_id":"cbdemo_business-suite-annual","plan_id":"cbdemo_business-suite","amount":115000,"currency":"INR","interval":"Year","interval_count":1,"trial_period":null,"trial_period_unit":null}]}]

Confirm subscription -

curl --location 'http://localhost:8080/subscriptions/sub_8zxmAZAfS0eTL8zRJRk7/confirm' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Profile-Id: pro_CohRshEanxkKSMHgyu6a' \
--header 'api-key: pk_dev_febeb0fab3be43c79024efaf99764d63' \
--data '{
    "item_price_id": "cbdemo_enterprise-suite-monthly",
    "description": "Hello this is description",
    "client_secret": "sub_8zxmAZAfS0eTL8zRJRk7_secret_IGg9yCNzrzoziV3odFLt",
    "shipping": {
        "address": {
            "state": "zsaasdas",
            "city": "Banglore",
            "country": "US",
            "line1": "sdsdfsdf",
            "line2": "hsgdbhd",
            "line3": "alsksoe",
            "zip": "571201",
            "first_name": "joseph",
            "last_name": "doe"
        },
        "phone": {
            "number": "123456789",
            "country_code": "+1"
        }
    },
    "billing": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "123456789",
            "country_code": "+1"
        }
    },
    "payment_details": {
        "payment_method": "card",
        "payment_method_type": "credit",
        "payment_method_data": {
            "card": {
                "card_number": "4111111111111111",
                "card_exp_month": "03",
                "card_exp_year": "2030",
                "card_holder_name": "CLBRW dffdg",
                "card_cvc": "737"
            }
        },
        "customer_acceptance": {
            "acceptance_type": "online",
            "accepted_at": "1963-05-03T04:07:52.723Z",
            "online": {
                "ip_address": "127.0.0.1",
                "user_agent": "amet irure esse"
            }
        }
    }
}'

Response -

{"id":"sub_8zxmAZAfS0eTL8zRJRk7","merchant_reference_id":null,"status":"active","plan_id":null,"price_id":null,"coupon":null,"profile_id":"pro_CohRshEanxkKSMHgyu6a","payment":{"payment_id":"pay_pPn6Tz2m3WrOIzANMF2g","status":"succeeded","amount":14100,"currency":"USD","connector":"stripe","payment_method_id":"pm_ZAtcND5u4SoRq6DnTQET","payment_experience":null,"error_code":null,"error_message":null,"payment_method_type":"credit","client_secret":"pay_pPn6Tz2m3WrOIzANMF2g_secret_Wxi6r52cBxz0ujhcWpAh"},"customer_id":"cus_d64F9yomaDMqbTDlxw3g","invoice":{"id":"invoice_nEqu7GMVqNMRzBorC9BS","subscription_id":"sub_8zxmAZAfS0eTL8zRJRk7","merchant_id":"merchant_1759849271","profile_id":"pro_CohRshEanxkKSMHgyu6a","merchant_connector_id":"mca_S0OzkqOOhMZs2jJQPSZo","payment_intent_id":"pay_pPn6Tz2m3WrOIzANMF2g","payment_method_id":"pm_ZAtcND5u4SoRq6DnTQET","customer_id":"cus_d64F9yomaDMqbTDlxw3g","amount":14100,"currency":"USD","status":"payment_pending"},"billing_processor_subscription_id":"sub_8zxmAZAfS0eTL8zRJRk7"}

invoice -

Checklist

I formatted the code cargo +nightly fmt --all
I addressed lints thrown by cargo clippy
I reviewed the submitted code
I added unit tests for my changes where possible

…n_get_plans

…h into subscriptions-client-auth

semanticdiff-com · 2025-10-07T12:46:21Z

Review changes with

Changed Files

File	Status
crates/router/src/routes/subscription.rs	43% smaller
crates/router/src/core/subscription.rs	43% smaller
crates/api_models/src/subscription.rs	39% smaller
crates/router/src/core/subscription/subscription_handler.rs	14% smaller
crates/diesel_models/src/invoice.rs	0% smaller
crates/diesel_models/src/schema.rs	0% smaller
crates/diesel_models/src/schema_v2.rs	0% smaller
crates/router/src/core/subscription/invoice_handler.rs	0% smaller
crates/router/src/core/webhooks/incoming.rs	0% smaller
crates/router/src/services/authentication.rs	0% smaller
crates/router/src/workflows/invoice_sync.rs	0% smaller
migrations/2025-10-07-130304_add_connector_invoice_id/down.sql	Unsupported file format
migrations/2025-10-07-130304_add_connector_invoice_id/up.sql	Unsupported file format

…ns-client-auth

crates/router/src/routes/subscription.rs

crates/router/src/core/subscription/subscription_handler.rs

jagan-jaya · 2025-10-08T07:05:34Z

migrations/2025-10-07-130304_add_connector_invoice_id/up.sql

@@ -0,0 +1,2 @@
+-- Your SQL goes here
+ALTER TABLE invoice ADD COLUMN IF NOT EXISTS connector_invoice_id VARCHAR(255);


Suggested change

ALTER TABLE invoice ADD COLUMN IF NOT EXISTS connector_invoice_id VARCHAR(255);

ALTER TABLE invoice ADD COLUMN IF NOT EXISTS connector_invoice_id VARCHAR(64);

jarnura · 2025-10-08T11:37:05Z

crates/api_models/src/subscription.rs

 }

+#[derive(serde::Deserialize, serde::Serialize, Debug)]
+pub struct GetSubscriptionQuery {


Get-subscription shouldn't be a client call, basically if a merchant wants to update their state with a response of hyperswitch then they shouldn't depend on the client to send data, instead they should depend on server to server communication which is safer and scalable with features

Currently it works with both S2S as well as client. Should we remove the client auth support of this? @jarnura

have removed client secret support

apoorvdixit88

Looks fine for dashboard changes.

…APIs (#9713) Co-authored-by: Prajjwal kumar <write2prajjwal@gmail.com> Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com> Co-authored-by: Prajjwal Kumar <prajjwal.kumar@juspay.in> Co-authored-by: Jagan <jaganelavarasan@gmail.com>

prajjwalkumar17 and others added 29 commits September 21, 2025 19:47

fix: resolve conflicts

7f7451c

fix lints

645bf21

fix: address comments

d7da18d

fix:lints

ef7e2e2

refactor: address comments

dde09b4

chore: run formatter

644d06f

clippy_v2

0139281

fix: address comments

22c38b1

add api_key auth

2fda2d1

Merge branch 'main' of github.com:juspay/hyperswitch into subscriptio…

12692db

…n_get_plans

refactor: Fixed handlers + implemented get_plans API

ac44189

chore: run formatter

9296f1b

fix: Fixed connector integration

b55ab36

chore: Resolved comments

a2dcc77

chore: run formatter

1924449

chore: Resolved comments

e3fa7f2

Merge branch 'main' of github.com:juspay/hyperswitch into subscriptio…

f64d31f

…n_get_plans

Merge branch 'main' of github.com:juspay/hyperswitch into subscriptio…

82849cd

…n_get_plans

fix: Fixed errors

487aa40

Merge branch 'main' of github.com:juspay/hyperswitch into subscriptio…

8af1f20

…n_get_plans

chore: run formatter

b2095d0

chore: Resolved comments

463fb5d

Merge branch 'main' into subscription_get_plans

1db0489

fix: Fixed clippy lints

b9cf9f9

refactor: Add confirm response to handler

702b4d5

chore: run formatter

f09b20b

Merge branch 'main' into subscription_get_plans

8bcdea6

Merge branch 'subscription_get_plans' of github.com:juspay/hyperswitc…

42250ac

…h into subscriptions-client-auth

feat: Add client auth in subscription APIs

9403c15

Sarthak1799 self-assigned this Oct 7, 2025

Sarthak1799 added 3 commits October 7, 2025 18:30

Merge branch 'main' of github.com:juspay/hyperswitch into subscriptio…

1713b14

…ns-client-auth

fix: Fixed errors

c723c0c

refactor: Add connector_invoice_id in invoice table

54de156

hyperswitch-bot bot added the M-database-changes Metadata: This PR involves database schema changes label Oct 7, 2025

Merge branch 'main' of github.com:juspay/hyperswitch into subscriptio…

b1a71a7

…ns-client-auth

Sarthak1799 linked an issue Oct 7, 2025 that may be closed by this pull request

[FEATURE] Add Client Auth for Subscriptions APIs #9705

Closed

2 tasks

jagan-jaya requested changes Oct 7, 2025

View reviewed changes

crates/router/src/routes/subscription.rs Show resolved Hide resolved

crates/router/src/core/subscription/subscription_handler.rs Outdated Show resolved Hide resolved

chore: Resolved comments

294c0e3

jagan-jaya requested changes Oct 8, 2025

View reviewed changes

Sarthak1799 added 4 commits October 8, 2025 13:44

chore: Resolved comments

aa09132

fix: Fixed migration tests

16d0d7d

chore: Resolved comments

60a8889

chore: Resolved comments

1b2caf9

Sarthak1799 removed the request for review from a team October 8, 2025 09:41

chore: Resolved comments

444164d

jagan-jaya previously approved these changes Oct 8, 2025

View reviewed changes

jarnura requested changes Oct 8, 2025

View reviewed changes

chore: Resolved comments

5569ec3

Sarthak1799 dismissed jagan-jaya’s stale review via 5569ec3 October 8, 2025 12:48

jagan-jaya approved these changes Oct 8, 2025

View reviewed changes

jarnura approved these changes Oct 8, 2025

View reviewed changes

ThisIsMani approved these changes Oct 8, 2025

View reviewed changes

apoorvdixit88 approved these changes Oct 8, 2025

View reviewed changes

likhinbopanna enabled auto-merge October 8, 2025 14:11

likhinbopanna added this pull request to the merge queue Oct 8, 2025

Merged via the queue into main with commit 01b4d6a Oct 8, 2025
26 of 29 checks passed

likhinbopanna deleted the subscriptions-client-auth branch October 8, 2025 15:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(subscriptions): Add client secret auth support in subscriptions APIs#9713

feat(subscriptions): Add client secret auth support in subscriptions APIs#9713
likhinbopanna merged 40 commits intomainfrom
subscriptions-client-auth

Sarthak1799 commented Oct 7, 2025 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Oct 7, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

jagan-jaya Oct 8, 2025

Uh oh!

jarnura Oct 8, 2025

Uh oh!

Sarthak1799 Oct 8, 2025

Uh oh!

Sarthak1799 Oct 8, 2025

Uh oh!

apoorvdixit88 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

		@@ -0,0 +1,2 @@
		-- Your SQL goes here
		ALTER TABLE invoice ADD COLUMN IF NOT EXISTS connector_invoice_id VARCHAR(255); No newline at end of file

Conversation

Sarthak1799 commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Uh oh!

semanticdiff-com bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jagan-jaya Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

jarnura Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

Sarthak1799 Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

Sarthak1799 Oct 8, 2025

Choose a reason for hiding this comment

Uh oh!

apoorvdixit88 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Sarthak1799 commented Oct 7, 2025 •

edited

Loading

semanticdiff-com bot commented Oct 7, 2025 •

edited

Loading