Creates a new Billing Credit record. Billing Credit resource in the Animal Health Data Store
Entity the credit is currently associated/applied to, if different from availability.
Canonical identifier for the billing credit.
Whether the credit is tracked as a quantity (e.g., visits) or a monetary value.
Total quantity or monetary amount originally granted for this credit.
Quantity or monetary amount that has been wasted or expired without use.
Identifier of the wellness plan benefit that generated this credit, if applicable.
Identifier of the wellness plan that generated this credit, if applicable.
Identifier of the membership cycle associated with this credit, if applicable.
Identifier of the wellness plan membership associated with this credit, if applicable.
Identifier of the membership status period associated with this credit, if applicable.
Classification of what the credit represents (e.g., visit count, service package, generic monetary credit).
Classification of the billing credit (e.g., promotion, refund, goodwill adjustment), represented as a coded concept.
Currency in which monetary billing credits are denominated, using a coded concept (e.g., ISO 4217). For quantity-based credits, this may be omitted.
- Mock serverhttps://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/billing-credit
- Local Developmenthttp://localhost:8083/site/{siteId}/ahds/v1/billing-credit
curl -i -X POST \
'https://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/billing-credit' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"appliedTo": {},
"availableTo": {},
"billingCreditId": "123e4567-e89b-12d3-a456-426614174000",
"creditType": "quantity",
"endDate": "2025-01-01",
"expiry": {},
"extensions": {},
"isActive": true,
"remainingAmount": 1.23,
"startDate": "2025-01-01",
"totalAmount": 1.23,
"usedAmount": 1.23,
"wastedAmount": 1.23,
"wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanMembershipCycleId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanMembershipStatusPeriodId": "123e4567-e89b-12d3-a456-426614174000",
"amountType": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"creditCategory": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"currency": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"measurementUnit": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
}
}'Billing Credit created successfully
Entity the credit is currently associated/applied to, if different from availability.
Canonical identifier for the billing credit.
Timestamp when the billing credit was created.
Whether the credit is tracked as a quantity (e.g., visits) or a monetary value.
Date on which the credit expires, if applicable.
Date from which the credit becomes valid.
Total quantity or monetary amount originally granted for this credit.
Timestamp when the billing credit was last updated.
Quantity or monetary amount that has been wasted or expired without use.
Identifier of the wellness plan benefit that generated this credit, if applicable.
Identifier of the wellness plan that generated this credit, if applicable.
Identifier of the membership cycle associated with this credit, if applicable.
Identifier of the wellness plan membership associated with this credit, if applicable.
Identifier of the membership status period associated with this credit, if applicable.
Classification of what the credit represents (e.g., visit count, service package, generic monetary credit).
Classification of the billing credit (e.g., promotion, refund, goodwill adjustment), represented as a coded concept.
Currency in which monetary billing credits are denominated, using a coded concept (e.g., ISO 4217). For quantity-based credits, this may be omitted.
{ "appliedTo": {}, "availableTo": {}, "billingCreditId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "creditType": "quantity", "endDate": "2025-01-01T00:00:00Z", "expiry": {}, "extensions": {}, "isActive": true, "remainingAmount": 1.23, "startDate": "2025-01-01T00:00:00Z", "totalAmount": 1.23, "updatedAt": "2025-01-01T00:00:00.000Z", "usedAmount": 1.23, "wastedAmount": 1.23, "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanMembershipCycleId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanMembershipStatusPeriodId": "123e4567-e89b-12d3-a456-426614174000", "amountType": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "creditCategory": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "currency": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "measurementUnit": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" } }