API Reference
Entities
- The entity endpoint
- POSTCreate an Individual
- POSTCreate a Corporation
- PUTUpdate an Entity
- GETRetrieve an Entity
- GETList all Entities
- Connect
- Verification Sessions
- Credit Scores
- Attributes
- Vehicles
- Identities
- Products
- Subscriptions
- Consent
Accounts
- The account endpoint
- POSTCreate an Account
- GETRetrieve an Account
- GETList all Accounts
- Updates
- Transactions
- Card Brand
- Attributes
- Payoffs
- Balances
- Sensitive
- Payment Instruments
- Products
- Subscriptions
- Verification Sessions
- Consent
Payments
Supporting Endpoints
- Merchants
- Webhooks
- Reports
- Simulations (Dev)
- Health Check
Subscriptions
Create a Subscription
POST
/
entities
/
{ent_id}
/
subscriptions
Copy
curl https://production.methodfi.com/entities/ent_TYHMaRJUUeJ7U/subscriptions \
-X POST \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
-H "Content-Type: application/json" \
-d '{
"enroll": "credit_score"
}'
Copy
{
"id": "sub_c3a7hVjHCJzF3",
"name": "credit_score",
"status": "active",
"payload": null,
"latest_request_id": null,
"created_at": "2024-04-18T18:48:33.875Z",
"updated_at": "2024-04-18T18:48:33.875Z"
}
Enrolls an Entity to a Subscription. Once enrolled, the Subscription name and details will be present on the response object.
Path Parameters
ID of the Entity.
Body
Used when subscribing to Attributes.
The attributes to subscribe to. See Attribute Objects.
Returns
Returns a Subscription object.
Copy
curl https://production.methodfi.com/entities/ent_TYHMaRJUUeJ7U/subscriptions \
-X POST \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
-H "Content-Type: application/json" \
-d '{
"enroll": "credit_score"
}'
Copy
{
"id": "sub_c3a7hVjHCJzF3",
"name": "credit_score",
"status": "active",
"payload": null,
"latest_request_id": null,
"created_at": "2024-04-18T18:48:33.875Z",
"updated_at": "2024-04-18T18:48:33.875Z"
}
Copy
curl https://production.methodfi.com/entities/ent_TYHMaRJUUeJ7U/subscriptions \
-X POST \
-H "Method-Version: 2024-04-04" \
-H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"
-H "Content-Type: application/json" \
-d '{
"enroll": "credit_score"
}'
Copy
{
"id": "sub_c3a7hVjHCJzF3",
"name": "credit_score",
"status": "active",
"payload": null,
"latest_request_id": null,
"created_at": "2024-04-18T18:48:33.875Z",
"updated_at": "2024-04-18T18:48:33.875Z"
}
Assistant
Responses are generated using AI and may contain mistakes.