Get the custom portal domain
The domain with its status, the portal address in use today and the two DNS records it needs. It only reads: it doesn't check the DNS at that moment.
Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.
In: header
Path Parameters
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/ec/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/portal-domain"{ "object": "portal_domain", "entity_id": "8161163a-f227-466f-bc01-090a01e80165", "hostname": "string", "status": "pending", "portal_url": "http://example.com", "dns_records": [ { "type": "CNAME", "name": "string", "value": "string" } ], "failure_code": "dns_not_pointing", "failure_reason": "string", "last_checked_at": "2019-08-24T14:15:22Z", "verified_at": "2019-08-24T14:15:22Z"}Change the monthly spending cap PUT
Only for a live business (`409` for a `sandbox` one). Sets how much, before IVA, the month's `live` documents above the included ones may cost: a document issues only while the usage amount with it stays within the cap. `0` stops at the included documents, a positive value allows them up to that amount and `null` removes the cap, which is the usual case. It does not touch documents already issued, which are billed as issued, and you can change it again whenever you like.
Set the custom portal domain PUT
Returns the `CNAME` and `TXT` records you must create. Only a business on Enterprise or with the custom portal domain add-on can use one.