feat(subscription): domain_model for subscription and invoice by AnkitKmrGupta · Pull Request #9640 · juspay/hyperswitch

AnkitKmrGupta · 2025-10-01T09:39:23Z

Type of Change

Description

This pull request introduces new domain models for subscriptions and invoices, and refactors the codebase to use these models instead of the previous Diesel-based models. The changes improve type safety and abstraction for subscription and invoice handling, and update relevant interfaces and function calls throughout the codebase to use the new models.

Domain Model Additions:

Added a new Subscription domain model in crates/hyperswitch_domain_models/src/subscription.rs, including the SubscriptionStatus enum, conversion traits, and the SubscriptionInterface trait for standardized operations. Also added the SubscriptionUpdate struct with conversion logic.
Added a new Invoice domain model in crates/hyperswitch_domain_models/src/invoice.rs, including conversion traits, the InvoiceInterface trait for CRUD operations, and the InvoiceUpdate struct with conversion logic.

Refactoring and Integration:

Refactored all subscription and invoice-related logic in crates/router/src/core/subscription.rs and crates/router/src/core/subscription/billing_processor_handler.rs to use the new domain models (hyperswitch_domain_models::subscription::Subscription and hyperswitch_domain_models::invoice::Invoice) instead of Diesel models. [1] [2] [3] [4] [5] [6] [7] [8]
Updated the invoice creation logic in invoice_handler.rs to use the new domain model and retrieve the merchant key store for secure operations.

Module Organization:

Registered the new invoice and subscription modules in crates/hyperswitch_domain_models/src/lib.rs for proper integration with the rest of the domain models. [1] [2]

These changes lay the groundwork for improved maintainability and extensibility in handling subscriptions and invoices in the codebase.

How did you test it?

Create Billing Connector

curl --location 'http://localhost:8080/account/merchant_1759737987/connectors' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: ****' \
--data '{
    "connector_type": "billing_processor",
    "connector_name": "chargebee",
    "connector_account_details": {
        "auth_type": "HeaderKey",
        "api_key": "****"
    },
    "business_country": "US",
    "business_label": "default",
    "connector_webhook_details": {
        "merchant_secret": "hyperswitch",
        "additional_secret": "hyperswitch"
    },
    "metadata": {
        "site": "hyperswitch-juspay3-test"
    }
}'

{
    "connector_type": "billing_processor",
    "connector_name": "chargebee",
    "connector_label": "chargebee_US_default",
    "merchant_connector_id": "mca_nyehf3o9gtzGgeVFzsx0",
    "profile_id": "pro_Ba2HYJtnuKdJzv2SBizB",
    "connector_account_details": {
        "auth_type": "HeaderKey",
        "api_key": "te**********************************MK"
    },
    "payment_methods_enabled": null,
    "connector_webhook_details": {
        "merchant_secret": "hyperswitch",
        "additional_secret": "hyperswitch"
    },
    "metadata": {
        "site": "hyperswitch-juspay3-test"
    },
    "test_mode": null,
    "disabled": false,
    "frm_configs": null,
    "business_country": "US",
    "business_label": "default",
    "business_sub_label": null,
    "applepay_verified_domains": null,
    "pm_auth_config": null,
    "status": "active",
    "additional_merchant_data": null,
    "connector_wallets_details": null
}

Update profile to set the billing processor

curl --location 'http://localhost:8080/account/merchant_1759737987/business_profile/pro_Ba2HYJtnuKdJzv2SBizB' \
--header 'Content-Type: application/json' \
--header 'api-key: ****' \
--data '{
  "billing_processor_id": "mca_nyehf3o9gtzGgeVFzsx0"
}'

{
    "merchant_id": "merchant_1759737987",
    "profile_id": "pro_Ba2HYJtnuKdJzv2SBizB",
    "profile_name": "US_default",
    "return_url": "https://google.com/success",
    "enable_payment_response_hash": true,
    "payment_response_hash_key": "BPIswjNm5ivN92rBE9J4ShmB2dfLVLeQ8DRnzY7cR7qsaUlfNpBgvnOCBWRfhR5e",
    "redirect_to_merchant_with_http_post": false,
    "webhook_details": {
        "webhook_version": "1.0.1",
        "webhook_username": "ekart_retail",
        "webhook_password": "password_ekart@123",
        "webhook_url": "https://webhook.site",
        "payment_created_enabled": true,
        "payment_succeeded_enabled": true,
        "payment_failed_enabled": true,
        "payment_statuses_enabled": null,
        "refund_statuses_enabled": null,
        "payout_statuses_enabled": null
    },
    "metadata": null,
    "routing_algorithm": null,
    "intent_fulfillment_time": 900,
    "frm_routing_algorithm": null,
    "payout_routing_algorithm": null,
    "applepay_verified_domains": null,
    "session_expiry": 900,
    "payment_link_config": null,
    "authentication_connector_details": null,
    "use_billing_as_payment_method_billing": true,
    "extended_card_info_config": null,
    "collect_shipping_details_from_wallet_connector": false,
    "collect_billing_details_from_wallet_connector": false,
    "always_collect_shipping_details_from_wallet_connector": false,
    "always_collect_billing_details_from_wallet_connector": false,
    "is_connector_agnostic_mit_enabled": false,
    "payout_link_config": null,
    "outgoing_webhook_custom_http_headers": null,
    "tax_connector_id": null,
    "is_tax_connector_enabled": false,
    "is_network_tokenization_enabled": false,
    "is_auto_retries_enabled": false,
    "max_auto_retries_enabled": null,
    "always_request_extended_authorization": null,
    "is_click_to_pay_enabled": false,
    "authentication_product_ids": null,
    "card_testing_guard_config": {
        "card_ip_blocking_status": "disabled",
        "card_ip_blocking_threshold": 3,
        "guest_user_card_blocking_status": "disabled",
        "guest_user_card_blocking_threshold": 10,
        "customer_id_blocking_status": "disabled",
        "customer_id_blocking_threshold": 5,
        "card_testing_guard_expiry": 3600
    },
    "is_clear_pan_retries_enabled": false,
    "force_3ds_challenge": false,
    "is_debit_routing_enabled": false,
    "merchant_business_country": null,
    "is_pre_network_tokenization_enabled": false,
    "acquirer_configs": null,
    "is_iframe_redirection_enabled": null,
    "merchant_category_code": null,
    "merchant_country_code": null,
    "dispute_polling_interval": null,
    "is_manual_retry_enabled": null,
    "always_enable_overcapture": null,
    "is_external_vault_enabled": "skip",
    "external_vault_connector_details": null,
    "billing_processor_id": "mca_nyehf3o9gtzGgeVFzsx0"
}

Create Customer

curl --location 'http://localhost:8080/customers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: ****' \
--data-raw '{
    "email": "guest@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "First customer",
    "address": {
        "line1": "1467",
        "line2": "Harrison Street",
        "line3": "Harrison Street",
        "city": "San Fransico",
        "state": "California",
        "zip": "94122",
        "country": "US",
        "first_name": "joseph",
        "last_name": "Doe"
    },
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

{
    "customer_id": "cus_EkIUbktzRFCHooI9Kylq",
    "name": "John Doe",
    "email": "guest@example.com",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "First customer",
    "address": {
        "city": "San Fransico",
        "country": "US",
        "line1": "1467",
        "line2": "Harrison Street",
        "line3": "Harrison Street",
        "zip": "94122",
        "state": "California",
        "first_name": "joseph",
        "last_name": "Doe",
        "origin_zip": null
    },
    "created_at": "2025-10-06T08:08:37.562Z",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
    "default_payment_method_id": null,
    "tax_registration_id": null
}

Create Subscription

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

{
    "id": "sub_Q1ttH0p1b50OtnDgZfrz",
    "merchant_reference_id": null,
    "status": "created",
    "plan_id": null,
    "profile_id": "pro_Ba2HYJtnuKdJzv2SBizB",
    "client_secret": "sub_Q1ttH0p1b50OtnDgZfrz_secret_jXFTn0oMPowj2RqRUcWX",
    "merchant_id": "merchant_1759737987",
    "coupon_code": null,
    "customer_id": "cus_EkIUbktzRFCHooI9Kylq"
}

Confirm Subscription

curl --location 'http://localhost:8080/subscriptions/sub_Q1ttH0p1b50OtnDgZfrz/confirm' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Profile-Id: pro_Ba2HYJtnuKdJzv2SBizB' \
--header 'api-key: ****' \
--data '{
    "item_price_id": "cbdemo_enterprise-suite-monthly",
    "customer_id": "cus_EkIUbktzRFCHooI9Kylq",
    "description": "Hello this is description",
    "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"
            }
        }
    }
}'

{
    "id": "sub_Q1ttH0p1b50OtnDgZfrz",
    "merchant_reference_id": null,
    "status": "active",
    "plan_id": null,
    "price_id": null,
    "coupon": null,
    "profile_id": "pro_Ba2HYJtnuKdJzv2SBizB",
    "payment": {
        "payment_id": "pay_uadWety0AlrsIpLa2Dt6",
        "status": "succeeded",
        "amount": 14100,
        "currency": "USD",
        "connector": "stripe",
        "payment_method_id": "pm_HBp7wdIyHsvnta708kxF",
        "payment_experience": null,
        "error_code": null,
        "error_message": null,
        "payment_method_type": "credit"
    },
    "customer_id": "cus_EkIUbktzRFCHooI9Kylq",
    "invoice": {
        "id": "invoice_UwA8TmKbXgxE1a7s6Nux",
        "subscription_id": "sub_Q1ttH0p1b50OtnDgZfrz",
        "merchant_id": "merchant_1759737987",
        "profile_id": "pro_Ba2HYJtnuKdJzv2SBizB",
        "merchant_connector_id": "mca_nyehf3o9gtzGgeVFzsx0",
        "payment_intent_id": "pay_uadWety0AlrsIpLa2Dt6",
        "payment_method_id": "pm_HBp7wdIyHsvnta708kxF",
        "customer_id": "cus_EkIUbktzRFCHooI9Kylq",
        "amount": 14100,
        "currency": "USD",
        "status": "payment_pending"
    },
    "billing_processor_subscription_id": "sub_Q1ttH0p1b50OtnDgZfrz"
}

Screenshots

…scription-domain_model

semanticdiff-com · 2025-10-01T09:39:26Z

Review changes with

Changed Files

File	Status
crates/router/src/core/subscription.rs	97% smaller
crates/router/src/workflows/invoice_sync.rs	53% smaller
crates/router/src/core/subscription/subscription_handler.rs	47% smaller
crates/router/src/core/subscription/invoice_handler.rs	26% smaller
crates/hyperswitch_domain_models/src/subscription.rs	2% smaller
crates/hyperswitch_domain_models/src/invoice.rs	0% smaller
crates/hyperswitch_domain_models/src/lib.rs	0% smaller
crates/router/src/core/subscription/billing_processor_handler.rs	0% smaller
crates/router/src/db.rs	0% smaller
crates/router/src/db/invoice.rs	0% smaller
crates/router/src/db/kafka_store.rs	0% smaller
crates/router/src/db/subscription.rs	0% smaller
crates/storage_impl/src/invoice.rs	0% smaller
crates/storage_impl/src/lib.rs	0% smaller
crates/storage_impl/src/subscription.rs	0% smaller

…scription-domain_model

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com> Co-authored-by: Jagan <jaganelavarasan@gmail.com>

…#9640) Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com> Co-authored-by: Jagan <jaganelavarasan@gmail.com>

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com> Co-authored-by: Jagan <jaganelavarasan@gmail.com>

AnkitKmrGupta added 6 commits September 23, 2025 17:38

subscription models conversion

82cf6da

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

69b1cdd

…scription-domain_model

feat: implement coversion for subscription

020761b

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

73a022c

…scription-domain_model

implement conversions for invoice and subscription

985cdc5

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

8410339

…scription-domain_model

AnkitKmrGupta requested review from a team as code owners October 1, 2025 09:39

refactor

8910294

AnkitKmrGupta changed the title ~~Subscription domain model~~ feat(subscription): subscription conversions Oct 1, 2025

AnkitKmrGupta and others added 8 commits October 2, 2025 02:14

added fields to domain invoice

963e76c

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

29e41a9

…scription-domain_model

chore: run formatter

140a3cf

resolve merge conflicts

e794575

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

b8ee2aa

…scription-domain_model

chore: run formatter

d6125cf

resolve conflicts

841c0e1

chore: run formatter

07b8a08

AnkitKmrGupta changed the title ~~feat(subscription): subscription conversions~~ feat(subscription): domain_model for subscription and invoice Oct 6, 2025

AnkitKmrGupta self-assigned this Oct 6, 2025

AnkitKmrGupta and others added 5 commits October 6, 2025 16:24

resolve clippy errors

9e4e757

refactor

3d8d023

chore: run formatter

3a0f0ed

refactor

4c1dce9

chore: run formatter

8b1ded3

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

feat(subscription): domain_model for subscription and invoice #9703

Closed

AnkitKmrGupta and others added 3 commits October 7, 2025 19:08

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

5aa2d2b

…scription-domain_model

resolve clippy errors

ded7ce3

chore: run formatter

184fbd8

jagan-jaya previously approved these changes Oct 8, 2025

View reviewed changes

jarnura previously approved these changes Oct 8, 2025

View reviewed changes

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

1385353

…scription-domain_model

AnkitKmrGupta dismissed stale reviews from jarnura and jagan-jaya via 1385353 October 8, 2025 16:26

AnkitKmrGupta and others added 2 commits October 8, 2025 22:37

resolve merge conflicts

b0d8d45

chore: run formatter

ce2d2bf

AnkitKmrGupta requested review from jagan-jaya and jarnura October 8, 2025 17:40

jagan-jaya approved these changes Oct 8, 2025

View reviewed changes

Merge branch 'main' into subscription-domain_model

9349569

jarnura approved these changes Oct 9, 2025

View reviewed changes

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

Merged via the queue into main with commit 17986c3 Oct 9, 2025
23 of 25 checks passed

likhinbopanna deleted the subscription-domain_model branch October 9, 2025 10:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(subscription): domain_model for subscription and invoice#9640

feat(subscription): domain_model for subscription and invoice#9640
likhinbopanna merged 27 commits intomainfrom
subscription-domain_model

AnkitKmrGupta commented Oct 1, 2025 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Oct 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

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

Uh oh!

Type of Change

Description

How did you test it?

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AnkitKmrGupta commented Oct 1, 2025 •

edited

Loading

semanticdiff-com bot commented Oct 1, 2025 •

edited

Loading