# Acknowledge a hosted page > For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt). [Idempotency Supported](/docs/api/idempotency) When a hosted page is successfully completed by the user and processed by Chargebee, its [`state`](/docs/api/hosted_pages/hosted_page-object#state) is automatically changed to `succeeded` . Acknowledging a hosted page confirms that you have moved the customer details from Chargebee into your system and are ready to fulfill it. This API is used to acknowledge the hosted page in `succeeded` state and change its state to `acknowledged` . **Note:** The hosted page status must be succeeded for this API call to be allowed. ## Sample Request #### cURL ```bash curl https://{site}.chargebee.com/api/v2/hosted_pages/__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0/acknowledge \ -X POST \ -u {site_api_key}: ``` #### .NET ```dotnet using ChargeBee.Api; using ChargeBee.Models; ApiConfig.Configure("{site}","{site_api_key}"); EntityResult result = HostedPage.Acknowledge("__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0").Request(); HostedPage hostedPage = result.HostedPage; ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v3" hostedpageAction "github.com/chargebee/chargebee-go/v3/actions/hostedpage" ) func main() { chargebee.Configure("{site_api_key}","{site}"); res,err := hostedpageAction.Acknowledge("__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0").Request() if err != nil { fmt.Println(err) } else { HostedPage := res.HostedPage } } ``` #### Go ```go package main import ( "fmt" "github.com/chargebee/chargebee-go/v4" ) func main() { config := &chargebee.ClientConfig{ SiteName: "{site}", ApiKey: "{site_api_key}", } client := chargebee.NewClient(config) req := &chargebee.HostedPageAcknowledgeRequest{ Id : "__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0", } res, err := client.HostedPage.Acknowledge(req) if err != nil { fmt.Println(err) } else { HostedPage := res.HostedPage } } ``` #### Java ```java import com.chargebee.*; import com.chargebee.ListResult; import com.chargebee.models.*; import com.chargebee.models.enums.*; import java.io.IOException; public class Sample { public static void main(String args[]) throws IOException, Exception { Environment.configure("{site}", "{site_api_key}"); Result result = HostedPage.acknowledge("__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0").request(); HostedPage hostedPage = result.hostedPage(); } } ``` #### Java ```java import com.chargebee.v4.client.ChargebeeClient; import com.chargebee.v4.models.hostedPage.HostedPage; import com.chargebee.v4.models.hostedPage.params.HostedPageAcknowledgeParams; import com.chargebee.v4.models.hostedPage.responses.HostedPageAcknowledgeResponse; public class HostedPageAcknowledge { public static void main(String[] args) { ChargebeeClient client = ChargebeeClient.builder() .apiKey("{site_api_key}") .siteName("{site}") .build(); HostedPageAcknowledgeResponse response = client.hostedPages().acknowledge("__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0"); HostedPage hostedPage = response.getHostedPage(); } } ``` #### Node.js ```node import Chargebee from "chargebee"; const chargebee = new Chargebee({ site: "{site}", apiKey: "{site_api_key}", }); try { const result = await chargebee.hostedPage.acknowledge("__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0"); console.log(result); const hostedPage = result.hosted_page; } catch (err) { console.log(err); } ``` #### PHP ```php "{site}", "apiKey" => "{site_api_key}", ]); $result = $chargebee->hostedPage()->acknowledge("__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0"); $hostedPage = $result->hosted_page; ``` #### Python ```python from chargebee import Chargebee cb_client = Chargebee(api_key="{site_api_key}", site="{site}") response = cb_client.HostedPage.acknowledge("__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0") hosted_page = response.hosted_page ``` #### Ruby ```ruby require 'chargebee' ChargeBee.configure(:site => "{site}", :api_key => "{site_api_key}") result = ChargeBee::HostedPage.acknowledge("__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0") hosted_page = result.hosted_page ``` ## Sample Response ```json { "hosted_page": { "content": { "card": { "card_type": "american_express", "customer_id": "__test__5SK0bLNFRFuFd5CuE", "expiry_month": 10, "expiry_year": 2020, "first_name": "Hello", "funding_type": "not_known", "gateway": "chargebee", "gateway_account_id": "gw___test__KyVnTyRFuFcGgDu", "iin": "378282", "ip_address": "127.0.0.1", "last4": "0005", "last_name": "World", "masked_number": "***********0005", "object": "card", "payment_source_id": "pm___test__5SK0bLNFRFuFfTGuV", "status": "valid" }, "credit_notes": [ { "allocations": [ { "allocated_amount": 895, "allocated_at": 1517507562, "invoice_date": 1517507562, "invoice_id": "__demo_inv__2", "invoice_status": "paid" }, {..} ], "amount_allocated": 895, "amount_available": 0, "amount_refunded": 0, "base_currency_code": "USD", "currency_code": "USD", "customer_id": "__test__5SK0bLNFRFuFd5CuE", "date": 1517507562, "deleted": false, "exchange_rate": 1, "id": "__demo_cn__1", "line_item_discounts": {}, "line_item_taxes": {}, "line_items": [ { "amount": 895, "date_from": 1517507562, "date_to": 1519926753, "description": "No Trial - Prorated Credits for 01-Feb-2018 - 01-Mar-2018", "discount_amount": 0, "entity_id": "no_trial", "entity_type": "plan", "id": "li___test__5SK0bLNFRFuFfTvuY", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "per_unit", "quantity": 1, "subscription_id": "__test__5SK0bLNFRFuFd5CuE", "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 895 }, {..} ], "linked_refunds": {}, "object": "credit_note", "price_type": "tax_exclusive", "reason_code": "subscription_change", "reference_invoice_id": "__demo_inv__1", "refunded_at": 1517507562, "resource_version": 1517507562000, "round_off_amount": 0, "status": "refunded", "sub_total": 895, "subscription_id": "__test__5SK0bLNFRFuFd5CuE", "taxes": {}, "total": 895, "type": "refundable", "updated_at": 1517507562 }, {..} ], "customer": { "allow_direct_debit": false, "auto_collection": "on", "billing_address": { "city": "Chennai", "country": "IN", "first_name": "Hello", "last_name": "World", "line1": "Wow", "line2": "Cool", "object": "billing_address", "phone": "122242222", "state": "Tamil Nadu", "state_code": "TN", "validation_status": "not_validated", "zip": "600041" }, "card_status": "valid", "created_at": 1517507553, "deleted": false, "email": "john@user.com", "excess_payments": 0, "first_name": "John", "id": "__test__5SK0bLNFRFuFd5CuE", "last_name": "Doe", "net_term_days": 0, "object": "customer", "payment_method": { "gateway": "chargebee", "gateway_account_id": "gw___test__KyVnTyRFuFcGgDu", "object": "payment_method", "reference_id": "tok___test__5SK0bLNFRFuFfTDuU", "status": "valid", "type": "card" }, "pii_cleared": "active", "preferred_currency_code": "USD", "primary_payment_source_id": "pm___test__5SK0bLNFRFuFfTGuV", "promotional_credits": 0, "refundable_credits": 0, "resource_version": 1517507562000, "taxability": "taxable", "unbilled_charges": 0, "updated_at": 1517507562 }, "invoice": { "adjustment_credit_notes": {}, "amount_adjusted": 0, "amount_due": 0, "amount_paid": 605, "amount_to_collect": 0, "applied_credits": [ { "applied_amount": 895, "applied_at": 1517507562, "cn_date": 1517507562, "cn_id": "__demo_cn__1", "cn_reason_code": "subscription_change", "cn_status": "refunded" }, {..} ], "base_currency_code": "USD", "billing_address": { "city": "Chennai", "country": "IN", "first_name": "Hello", "last_name": "World", "line1": "Wow", "line2": "Cool", "object": "billing_address", "phone": "122242222", "state": "Tamil Nadu", "state_code": "TN", "validation_status": "not_validated", "zip": "600041" }, "credits_applied": 895, "currency_code": "USD", "customer_id": "__test__5SK0bLNFRFuFd5CuE", "date": 1517507562, "deleted": false, "due_date": 1517507562, "exchange_rate": 1, "first_invoice": false, "has_advance_charges": false, "id": "__demo_inv__2", "is_gifted": false, "issued_credit_notes": {}, "line_items": [ { "amount": 1500, "date_from": 1517507562, "date_to": 1519926753, "description": "Plan1 - Prorated Charges", "discount_amount": 0, "entity_id": "plan1", "entity_type": "plan", "id": "li___test__5SK0bLNFRFuFfTpuW", "is_taxed": false, "item_level_discount_amount": 0, "object": "line_item", "pricing_model": "per_unit", "quantity": 1, "subscription_id": "__test__5SK0bLNFRFuFd5CuE", "tax_amount": 0, "tax_exempt_reason": "tax_not_configured", "unit_amount": 1500 }, {..} ], "linked_orders": {}, "linked_payments": [ { "applied_amount": 605, "applied_at": 1517507562, "txn_amount": 605, "txn_date": 1517507562, "txn_id": "txn___test__5SK0bLNFRFuFfUeua", "txn_status": "success" }, {..} ], "net_term_days": 0, "object": "invoice", "paid_at": 1517507562, "price_type": "tax_exclusive", "recurring": true, "resource_version": 1517507562000, "round_off_amount": 0, "shipping_address": { "city": "Chennai", "country": "IN", "first_name": "Hello", "last_name": "World", "line1": "Wow", "line2": "Cool", "object": "shipping_address", "phone": "122242222", "state": "Tamil Nadu", "state_code": "TN", "validation_status": "not_validated", "zip": "600041" }, "status": "paid", "sub_total": 1500, "subscription_id": "__test__5SK0bLNFRFuFd5CuE", "tax": 0, "term_finalized": true, "total": 1500, "updated_at": 1517507562, "write_off_amount": 0 }, "subscription": { "activated_at": 1517507553, "billing_period": 1, "billing_period_unit": "month", "created_at": 1517507553, "currency_code": "USD", "current_term_end": 1519926753, "current_term_start": 1517507553, "customer_id": "__test__5SK0bLNFRFuFd5CuE", "deleted": false, "due_invoices_count": 0, "has_scheduled_changes": false, "id": "__test__5SK0bLNFRFuFd5CuE", "mrr": 0, "next_billing_at": 1519926753, "object": "subscription", "plan_amount": 1500, "plan_free_quantity": 0, "plan_id": "plan1", "plan_quantity": 1, "plan_unit_price": 1500, "resource_version": 1517507562000, "shipping_address": { "city": "Chennai", "country": "IN", "first_name": "Hello", "last_name": "World", "line1": "Wow", "line2": "Cool", "object": "shipping_address", "phone": "122242222", "state": "Tamil Nadu", "state_code": "TN", "validation_status": "not_validated", "zip": "600041" }, "started_at": 1517507553, "status": "active", "updated_at": 1517507562 } }, "created_at": 1517507553, "embed": false, "expires_at": 1517511153, "id": "__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0", "layout": "in_app", "object": "hosted_page", "resource_version": 1517507577000, "state": "acknowledged", "type": "checkout_existing", "updated_at": 1517507577, "url": "https://yourapp.chargebee.com/pages/v3/__test__p541yXSwQO7jD2oRNFlBSvqU2s0oiWY0/" } } ``` ## URL Format **POST** https://[site].chargebee.com/api/v2/hosted_pages/{hosted-page-id}/acknowledge ## Returns - `hosted_page` (Hosted page object) Resource object representing hosted\_page