POST
/
subscriptions
/
eligibility
/
payment_methods
curl --request POST \
  --url https://sandbox.cashfree.com/pg/subscriptions/eligibility/payment_methods \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "queries": {
    "subscription_id": "test-subscription-1"
  },
  "filters": {
    "payment_methods": []
  }
}'

Authorizations

ā€‹
x-client-id
string
headerrequired

Client app ID. You can find your app id in the Merchant Dashboard.

ā€‹
x-client-secret
string
headerrequired

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

ā€‹
x-api-version
string
default: 2023-08-01required

API version to be used. Format is in YYYY-MM-DD

ā€‹
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

ā€‹
x-idempotency-key
string

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Body

application/json

Request body to fetch subscription eligibile payment method details.

ā€‹
queries
object
required

Necessary parameters to fetch eligible payment methods.

ā€‹
filters
object

Filters to refine eligible payment method selection.

Response

200 - application/json

Subscrition eligibility API response

ā€‹
type
object[]

List of eligibile payment methods for the subscription.

Was this page helpful?

API to upload file for Physical Nach Authorization.Raise a charge or create an auth.